icicle attributes

Icicle charts: a hierarchy as rows or columns of cells sized by value, placed by domain, with a path bar and animated drill-down, drawn as one instanced GPU rect set with batched SDF labels.

• Categories: domain, icicle
• Plotly equivalent: icicle
• Guide: icicle chart page
• Used in examples: demos/index-funds/sp500-icicle, demos/science-basics/matter-icicle, demos/tqqq-soxl/holdings-icicle, icicle/basic, icicle/colorscale, icicle/depth, icicle/flip, icicle/levels, icicle/uniformtext, icicle/vertical

Generated from the attribute schema (208 entries). Machine-readable: plot-schema.json.

Attribute tree

• type
• visible
• name
• uid
• showlegend
• legend
• legendgroup
• hovertext
• hoverinfo
• hovertemplate
• hoverlabel

  • bgcolor
  • bordercolor
  • font

    • family
    • size
    • color
  • align
  • namelength
• selectedpoints
• legendrank
• legendwidth
• legendgrouptitle

  • text
  • font

    • family
    • size
    • color
    • weight
    • style
• opacity
• meta
• customdata
• ids
• dataset
• uirevision
• styleRules
• domain

  • x
  • y
  • row
  • column
• labels
• parents
• values
• branchvalues
• count
• level
• maxdepth
• tiling

  • orientation
  • flip
  • pad
• marker

  • colors
  • colorscale
  • autocolorscale
  • reversescale
  • cauto
  • cmin
  • cmax
  • cmid
  • showscale
  • colorbar

    • orientation
    • thicknessmode
    • thickness
    • lenmode
    • len
    • x
    • xref
    • xanchor
    • xpad
    • y
    • yref
    • yanchor
    • ypad
    • outlinecolor
    • outlinewidth
    • bordercolor
    • borderwidth
    • bgcolor
    • tickmode
    • nticks
    • tick0
    • dtick
    • tickvals
    • ticktext
    • ticks
    • ticklen
    • tickwidth
    • tickcolor
    • ticklabelposition
    • ticklabeloverflow
    • ticklabelstep
    • showticklabels
    • tickfont

      • family
      • size
      • color
      • weight
      • style
      • variant
      • textcase
      • lineposition
      • shadow
    • tickangle
    • tickformat
    • tickprefix
    • showtickprefix
    • ticksuffix
    • showticksuffix
    • separatethousands
    • exponentformat
    • minexponent
    • showexponent
    • title

      • text
      • font

        • family
        • size
        • color
        • weight
        • style
        • variant
        • textcase
        • lineposition
        • shadow
      • side
  • coloraxis
  • line

    • color
    • width
  • pattern

    • shape
    • fillmode
    • bgcolor
    • fgcolor
    • fgopacity
    • size
    • solidity
• leaf

  • opacity
• root

  • color
• sort
• pathbar

  • visible
  • side
  • edgeshape
  • thickness
  • textfont

    • family
    • size
    • color
    • weight
    • style
• text
• textinfo
• texttemplate
• textfont

  • family
  • size
  • color
  • weight
  • style
• insidetextfont

  • family
  • size
  • color
  • weight
  • style
• outsidetextfont

  • family
  • size
  • color
  • weight
  • style
• textposition
• depth
• bevel

  • size
  • segments
• material

  • type
  • roughness
  • metalness
  • shininess
  • specular
  • emissive
  • emissiveintensity
  • reflectivity
  • envmapintensity
  • clearcoat
  • clearcoatroughness
  • transmission
  • ior
  • thickness
  • sheen
  • sheencolor
  • sheenroughness
  • iridescence
  • steps
  • matcap
  • castshadow
  • receiveshadow
• tilt
• perspective

type string

Trace type, e.g. 'scatter'. Defaults to 'scatter'.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

visible enumerated

Whether the trace is drawn. legendonly hides it but keeps its (toggleable) legend entry.

• Type: enumerated
• Values: true | false | "legendonly"
• Default: true
• Array OK: no
• Edit type: calc
• Animatable: no

name string

Trace name shown in the legend and hover labels. Defaults to trace N.

• Type: string
• Default: none
• Array OK: no
• Edit type: legend+plot
• Animatable: no

uid string

Stable identity used to match traces across updates, so reordered traces are moved instead of rebuilt.

• Type: string
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

showlegend boolean

Whether this trace has a legend entry.

• Type: boolean
• Default: true
• Array OK: no
• Edit type: legend+layout
• Animatable: no

legend subplotid

The legend this trace's item is shown in: 'legend' (layout.legend), 'legend2' (layout.legend2), ….

• Type: subplotid (legend, legend2, legend3, …)
• Default: "legend"
• Array OK: no
• Edit type: legend+layout
• Animatable: no

legendgroup string

Traces in the same legend group toggle together.

• Type: string
• Default: ""
• Array OK: no
• Edit type: legend
• Animatable: no

hovertext string

Hover text per point; defaults to text.

• Type: string
• Default: ""
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

hoverinfo flaglist

Which fields hover labels show, in a fixed order (percentages read '25% of Eve'); 'skip' also turns hover events off for this trace.

• Type: flaglist
• Flags: "label", "text", "value", "name", "current path", "percent root", "percent entry", "percent parent" (combine with +)
• Also accepts: "all" | "none" | "skip"
• Default: "label+text+value+name"
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hovertemplate string

Template for hover labels, e.g. '%{x}: %{y:.2f}<extra></extra>' (d3-format / d3-time-format after : / |). Overrides hoverinfo.

• Type: string
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel

Hover label style for this trace. Unset fields fall back to layout.hoverlabel (so there are no trace-level defaults).

• Type: object
• Edit type: none

hoverlabel.bgcolor color

Label background. Default: the point color.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel.bordercolor color

Label border. Default: contrasting with the background.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel.font

Label font.

• Type: object
• Edit type: none

hoverlabel.font.family string

Font family.

• Type: string
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel.font.size number

Font size in px.

• Type: number ≥ 1
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel.font.color color

Font color.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel.align enumerated

Text alignment inside labels.

• Type: enumerated
• Values: "left" | "right" | "auto"
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

hoverlabel.namelength integer

Characters of the trace name shown (-1: all, 0: none).

• Type: integer ≥ -1
• Default: none
• Array OK: yes (one value per point)
• Edit type: none
• Animatable: no

selectedpoints any

Indices of the selected points (set by box/lasso selection, or programmatically). null clears the selection.

• Type: any
• Default: none
• Array OK: no
• Edit type: style
• Animatable: no

legendrank number

Sort key for legend entries: lower ranks come first (top, or left). Ties keep trace order; traces default to 1000.

• Type: number
• Default: 1000
• Array OK: no
• Edit type: legend
• Animatable: no

legendwidth number

Width of this trace's item in horizontal legends, overriding legend.entrywidth (same units). Default: its text's.

• Type: number ≥ 0
• Default: none
• Array OK: no
• Edit type: legend
• Animatable: no

legendgrouptitle

Title of the legend group this trace belongs to.

• Type: object
• Edit type: legend

legendgrouptitle.text string

Title heading this trace's legend group.

• Type: string
• Default: ""
• Array OK: no
• Edit type: legend
• Animatable: no

legendgrouptitle.font

Group title font. Unset fields come from legend.grouptitlefont.

• Type: object
• Edit type: legend

legendgrouptitle.font.family string

Font family.

• Type: string
• Default: none
• Array OK: no
• Edit type: legend
• Animatable: no

legendgrouptitle.font.size number

Font size in px.

• Type: number ≥ 1
• Default: none
• Array OK: no
• Edit type: legend
• Animatable: no

legendgrouptitle.font.color color

Font color.

• Type: color
• Default: none
• Array OK: no
• Edit type: legend
• Animatable: no

legendgrouptitle.font.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: legend
• Animatable: no

legendgrouptitle.font.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: legend
• Animatable: no

opacity number

Opacity of the whole trace.

• Type: number from 0 to 1
• Default: 1
• Array OK: no
• Edit type: style
• Animatable: yes

meta any

Arbitrary user data, available in text templates as %{meta}.

• Type: any
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

customdata data_array

Per-point user data, returned in events and available in hover templates.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

ids data_array

Per-point ids used to match points across animation frames.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

dataset string

Name of a figure-level dataset (figure.datasets). Data arrays, and per-point attributes whose values cannot start with @ (such as colors and sizes), may then reference its columns as '@column'; on string attributes such as text, '@…' stays literal text.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

uirevision any

While unchanged, user interaction state for this trace (legend visibility, selections) is kept across updates.

• Type: any
• Default: none
• Array OK: no
• Edit type: none
• Animatable: no

styleRules any

Conditional per-point styling as JSON (plan E8.5): [{ when: { y: { gt: 10 } }, set: { 'marker.color': 'gold' } }]. when tests fields of the point ('y', 'customdata[1]', 'pointNumber', …) with eq, ne, gt, gte, lt, lte, in, nin, between, regex, and, or and not; set gives per-point (arrayOk) attributes a value on the matching points. Later rules win; other points keep the trace's own value.

• Type: any
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

domain

Where this trace is drawn, as a part of the plot area.

• Type: object
• Edit type: plot

domain.x info_array

Horizontal extent [start, end] of this trace as fractions of the plot area. Defaults to the layout.grid column when column is set, else [0, 1].

• Type: info_array [number, number]
• Default: [0, 1]
• Array OK: no
• Edit type: plot
• Animatable: no

domain.y info_array

Vertical extent [start, end] of this trace as fractions of the plot area (from the bottom). Defaults to the layout.grid row when row is set, else [0, 1].

• Type: info_array [number, number]
• Default: [0, 1]
• Array OK: no
• Edit type: plot
• Animatable: no

domain.row integer

Row of the layout.grid cell this trace is placed in (0 = first row in roworder). Only used with a grid.

• Type: integer ≥ 0
• Default: 0
• Array OK: no
• Edit type: plot
• Animatable: no

domain.column integer

Column of the layout.grid cell this trace is placed in (0 = leftmost). Only used with a grid.

• Type: integer ≥ 0
• Default: 0
• Array OK: no
• Edit type: plot
• Animatable: no

labels data_array

Label of each cell. Without ids, labels are also the node ids parents refer to, so they must be unique among parents.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

parents data_array

Parent of each node: its id (an ids entry, else a labels entry). '' marks a root; several roots get a generated root above them. Without any '', the one parent that is not a node becomes the root.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

values data_array

Value of each cell, a number ≥ 0 (rows with other values are dropped). How branches add up is branchvalues; without values, nodes are sized by count.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

branchvalues enumerated

How values of branches are read: remainder adds each node's value to its descendants' (a branch is bigger than its children), total takes it as the branch's total, which must not be less than its children's sum (the trace is not drawn otherwise).

• Type: enumerated
• Values: "remainder" | "total"
• Default: "remainder"
• Array OK: no
• Edit type: calc
• Animatable: no

count flaglist

Without values: what a node counts to size it — the leaves below it, its branches, or both.

• Type: flaglist
• Flags: "branches", "leaves" (combine with +)
• Default: "leaves"
• Array OK: no
• Edit type: calc
• Animatable: no

level any

Id of the node shown as the root (the entry): '' or unset for the whole hierarchy. Clicking a node sets it (drill-down); clicking the entry goes back up.

• Type: any
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

maxdepth integer

Levels drawn from the entry down, the entry included; -1 draws them all. Deeper nodes appear when drilling in.

• Type: integer
• Default: -1
• Array OK: no
• Edit type: plot
• Animatable: no

tiling

How cells are laid out.

• Type: object
• Edit type: calc

tiling.orientation enumerated

Direction levels go in: h from left to right (right to left with flip: x), v from top to bottom (bottom to top with flip: y).

• Type: enumerated
• Values: "v" | "h"
• Default: "h"
• Array OK: no
• Edit type: plot
• Animatable: no

tiling.flip flaglist

Mirror the layout along x and / or y.

• Type: flaglist
• Flags: "x", "y" (combine with +)
• Default: ""
• Array OK: no
• Edit type: plot
• Animatable: no

tiling.pad number

Gap between cells, px.

• Type: number ≥ 0
• Default: 0
• Array OK: no
• Edit type: plot
• Animatable: no

marker

Cell style.

• Type: object
• Edit type: calc

marker.colors data_array

Color of each cell: CSS colors, or numbers mapped through colorscale. Unset cells take layout.<type>colorway colors on the first level and their parent's color below it.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.colorscale colorscale

Colorscale for numeric marker.colors values: a name ('Viridis', 'RdBu', …), a list of colors, or [position, color] stops from 0 to 1.

• Type: colorscale
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.autocolorscale boolean

Pick the colorscale from the sign of the color domain (Reds for ≥ 0, Blues for ≤ 0, RdBu across 0). Defaults to true unless colorscale is given.

• Type: boolean
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.reversescale boolean

Reverse the colorscale (the lowest value gets the last color).

• Type: boolean
• Default: false
• Array OK: no
• Edit type: calc
• Animatable: no

marker.cauto boolean

Compute the color domain from the numeric marker.colors values. Defaults to false when both cmin and cmax are given.

• Type: boolean
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.cmin number

Value mapped to the first colorscale color (with cmax; turns cauto off).

• Type: number
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.cmax number

Value mapped to the last colorscale color (with cmin; turns cauto off).

• Type: number
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.cmid number

With cauto, widen the automatic domain so it is symmetric around this value (diverging data).

• Type: number
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

marker.showscale boolean

Show a colorbar for this colorscale (drawn by the colorbar component, plan E5.3).

• Type: boolean
• Default: false
• Array OK: no
• Edit type: calc
• Animatable: no

marker.colorbar

The colorbar of this colorscale (plan E5.3).

• Type: object
• Edit type: colorbars+layout

marker.colorbar.orientation enumerated

Vertical bar (v, beside the plot) or horizontal bar (h, above or below).

• Type: enumerated
• Values: "h" | "v"
• Default: "v"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.thicknessmode enumerated

Unit of thickness: px, or a fraction of the plot width (v) / height (h).

• Type: enumerated
• Values: "fraction" | "pixels"
• Default: "pixels"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.thickness number

Thickness of the color bar.

• Type: number ≥ 0
• Default: 30
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.lenmode enumerated

Unit of len: px, or a fraction of the plot height (v) / width (h).

• Type: enumerated
• Values: "fraction" | "pixels"
• Default: "fraction"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.len number

Length of the colorbar along its axis, padding included (ypad / xpad).

• Type: number ≥ 0
• Default: 1
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.x number

Horizontal position (xref fraction). Defaults to 1.02 (v, paper), 1 (v, container) or 0.5 (h).

• Type: number
• Default: none
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.xref enumerated

Reference of x: the plot area (paper) or the whole figure.

• Type: enumerated
• Values: "container" | "paper"
• Default: "paper"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.xanchor enumerated

Which side of the colorbar sits at x. Defaults to left (v, paper), right (v, container) or center (h).

• Type: enumerated
• Values: "left" | "center" | "right"
• Default: none
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.xpad number

Horizontal padding, px.

• Type: number ≥ 0
• Default: 10
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.y number

Vertical position (yref fraction). Defaults to 0.5 (v), 1.02 (h, paper) or 1 (h, container).

• Type: number
• Default: none
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.yref enumerated

Reference of y: the plot area (paper) or the whole figure.

• Type: enumerated
• Values: "container" | "paper"
• Default: "paper"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.yanchor enumerated

Which side of the colorbar sits at y. Defaults to middle (v), bottom (h, paper) or top (h, container).

• Type: enumerated
• Values: "top" | "middle" | "bottom"
• Default: none
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.ypad number

Vertical padding, px.

• Type: number ≥ 0
• Default: 10
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.outlinecolor color

Color of the outline around the bar.

• Type: color
• Default: "#444"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.outlinewidth number

Outline width, px.

• Type: number ≥ 0
• Default: 1
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.bordercolor color

Border color of the colorbar box.

• Type: color
• Default: "#444"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.borderwidth number

Border width of the box, px.

• Type: number ≥ 0
• Default: 0
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.bgcolor color

Background of the box.

• Type: color
• Default: "rgba(0, 0, 0, 0)"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.tickmode enumerated

auto picks up to nticks round ticks; linear places ticks from tick0 every dtick; array uses tickvals/ticktext; sync aligns with the overlaid axis (reserved; behaves as auto). Defaults to array when tickvals is set, linear when dtick is set, else auto.

• Type: enumerated
• Values: "auto" | "linear" | "array" | "sync"
• Default: none
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.nticks integer

Maximum number of ticks for tickmode: auto (the actual number may be lower so steps stay round). 0 picks it from the axis length.

• Type: integer ≥ 0
• Default: 0
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tick0 any

Position of one tick for tickmode: linear (data units; a date on date axes, an exponent on log axes unless dtick is L<f>). Defaults to 0, or 2000-01-01 on date axes.

• Type: any
• Default: none
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.dtick any

Tick step. Linear axes: a positive number. Log axes: an integer n (a tick every n decades), L<f> (linear steps of f in data units, e.g. L0.5), D1 (every digit) or D2 (1, 2 and 5). Date axes: milliseconds, or M<n> for n months (M12 for years).

• Type: any
• Default: none
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tickvals data_array

Tick positions for tickmode: array (data units).

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.ticktext data_array

Tick labels for tickvals. Missing entries are formatted as usual.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.ticks enumerated

Draw tick marks outside or inside the plot area, or not at all ('').

• Type: enumerated
• Values: "outside" | "inside" | ""
• Default: ""
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.ticklen number

Tick length in px.

• Type: number ≥ 0
• Default: 5
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tickwidth number

Tick width in px.

• Type: number ≥ 0
• Default: 1
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tickcolor color

Tick color. Defaults to color.

• Type: color
• Default: "#444"
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.ticklabelposition enumerated

Tick labels outside the bar (away from it) or inside (over it); top/bottom (v) or left/right (h) move them beside their tick.

• Type: enumerated
• Values: "outside" | "inside" | "outside top" | "inside top" | "outside bottom" | "inside bottom" | "outside left" | "inside left" | "outside right" | "inside right"
• Default: "outside"
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.ticklabeloverflow enumerated

Hide labels past the figure or past the bar. Defaults to hide past domain for inside labels, else hide past div.

• Type: enumerated
• Values: "allow" | "hide past div" | "hide past domain"
• Default: none
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.ticklabelstep integer

Label every n-th tick only (tickmode auto and linear).

• Type: integer ≥ 1
• Default: 1
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.showticklabels boolean

Show tick labels.

• Type: boolean
• Default: true
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tickfont

Tick-label font. Defaults to layout.font.

• Type: object
• Edit type: layout+plot

marker.colorbar.tickfont.family string

CSS font-family list. The renderer uses the first family it can load and falls back through the list.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.size number

Font size in CSS pixels.

• Type: number ≥ 1
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.color color

Text color.

• Type: color
• Default: none
• Array OK: no
• Edit type: style
• Animatable: no

marker.colorbar.tickfont.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.variant enumerated

Capitals variant (CSS font-variant-caps). The SDF text renderer approximates small and petite caps with uppercase letters at a reduced size.

• Type: enumerated
• Values: "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.textcase enumerated

Letter case transform: upper, lower, word caps (first letter of each word), or normal.

• Type: enumerated
• Values: "normal" | "word caps" | "upper" | "lower"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.lineposition flaglist

Text decoration: under, over and/or through joined with + (e.g. under+over), or none.

• Type: flaglist
• Flags: "under", "over", "through" (combine with +)
• Also accepts: "none"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickfont.shadow string

CSS text-shadow behind the text (2px 2px 3px black; only the first shadow is drawn), none, or auto for a thin halo in the contrast color of the text.

• Type: string
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.tickangle angle

Tick-label rotation in degrees. auto rotates x-axis labels by the first autotickangles entry that avoids overlap.

• Type: angle (degrees), or "auto"
• Default: "auto"
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tickformat string

Tick-label format: a d3-format specifier for numbers (.2f, ~s, $,) or a d3-time-format specifier for dates (%b %Y), plus %{n}f for n digits of fractional seconds and %h for the half year. Empty picks a format automatically.

• Type: string
• Default: ""
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.tickprefix string

Text before each tick label.

• Type: string
• Default: ""
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.showtickprefix enumerated

Which tick labels get tickprefix.

• Type: enumerated
• Values: "all" | "first" | "last" | "none"
• Default: "all"
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.ticksuffix string

Text after each tick label.

• Type: string
• Default: ""
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.showticksuffix enumerated

Which tick labels get ticksuffix.

• Type: enumerated
• Values: "all" | "first" | "last" | "none"
• Default: "all"
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.separatethousands boolean

Always separate thousands (1,000). By default only numbers with 5 or more integer digits are separated.

• Type: boolean
• Default: false
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.exponentformat enumerated

How large and small numbers are written: none (1000000), e (1e+6), E (1E+6), power (1×10⁶), SI (1M), B (like SI but 1B for 10⁹).

• Type: enumerated
• Values: "none" | "e" | "E" | "power" | "SI" | "B"
• Default: "B"
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.minexponent number

Smallest decimal exponent written in exponent form (SI/B and exponent formats); smaller magnitudes are written out in full.

• Type: number ≥ 0
• Default: 3
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.showexponent enumerated

Which tick labels show the exponent.

• Type: enumerated
• Values: "all" | "first" | "last" | "none"
• Default: "all"
• Array OK: no
• Edit type: colorbars+layout
• Animatable: no

marker.colorbar.title

Colorbar title.

• Type: object
• Edit type: colorbars+layout

marker.colorbar.title.text string

Colorbar title.

• Type: string
• Default: ""
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.colorbar.title.font

Title font. Defaults to layout.font with the tick-label family and 1.2 × its size.

• Type: object
• Edit type: layout+plot

marker.colorbar.title.font.family string

CSS font-family list. The renderer uses the first family it can load and falls back through the list.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.size number

Font size in CSS pixels.

• Type: number ≥ 1
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.color color

Text color.

• Type: color
• Default: none
• Array OK: no
• Edit type: style
• Animatable: no

marker.colorbar.title.font.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.variant enumerated

Capitals variant (CSS font-variant-caps). The SDF text renderer approximates small and petite caps with uppercase letters at a reduced size.

• Type: enumerated
• Values: "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.textcase enumerated

Letter case transform: upper, lower, word caps (first letter of each word), or normal.

• Type: enumerated
• Values: "normal" | "word caps" | "upper" | "lower"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.lineposition flaglist

Text decoration: under, over and/or through joined with + (e.g. under+over), or none.

• Type: flaglist
• Flags: "under", "over", "through" (combine with +)
• Also accepts: "none"
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.font.shadow string

CSS text-shadow behind the text (2px 2px 3px black; only the first shadow is drawn), none, or auto for a thin halo in the contrast color of the text.

• Type: string
• Default: none
• Array OK: no
• Edit type: layout+plot (inherited)
• Animatable: no

marker.colorbar.title.side enumerated

Where the title goes relative to the bar. Defaults to top (v) or right (h).

• Type: enumerated
• Values: "right" | "top" | "bottom"
• Default: none
• Array OK: no
• Edit type: colorbars+layout (inherited)
• Animatable: no

marker.coloraxis subplotid

Share a colorscale and domain with other traces through layout.coloraxis ('coloraxis', 'coloraxis2', …). Overrides this container's colorscale attributes.

• Type: subplotid (coloraxis, coloraxis2, coloraxis3, …)
• Default: "coloraxis"
• Array OK: no
• Edit type: calc
• Animatable: no

marker.line

Cell outlines.

• Type: object
• Edit type: calc

marker.line.color color

Outline color, or one per cell. Default: paper_bgcolor.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

marker.line.width number

Outline width in CSS px (centered on the edge), or one per cell.

• Type: number ≥ 0
• Default: 1
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

marker.pattern

Hatch pattern of the cell fill (drawn in screen px, for print and grayscale).

• Type: object
• Edit type: style

marker.pattern.shape enumerated

Hatch shape: diagonal ('/', '\\', 'x'), horizontal and vertical ('-', '|', '+') lines or dots ('.'); '' for none, or one per cell.

• Type: enumerated
• Values: "" | "/" | "\\" | "x" | "-" | "|" | "+" | "."
• Default: ""
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

marker.pattern.fillmode enumerated

'replace': the pattern in the fill color on bgcolor (default transparent) replaces the fill; 'overlay': the pattern is drawn over the fill color, in its contrast color at half opacity by default.

• Type: enumerated
• Values: "replace" | "overlay"
• Default: "replace"
• Array OK: no
• Edit type: style
• Animatable: no

marker.pattern.bgcolor color

Pattern background. Default: the fill color with fillmode: 'overlay', else transparent, or one per cell.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

marker.pattern.fgcolor color

Pattern color. Default: the fill color with fillmode: 'replace', else white or dark grey, whichever contrasts with bgcolor, or one per cell.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

marker.pattern.fgopacity number

Opacity of the pattern color. Default 0.5 with fillmode: 'overlay', else 1.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: style
• Animatable: no

marker.pattern.size number

Size of the pattern's tiles in CSS px: the spacing of its lines or dots, or one per cell.

• Type: number ≥ 0
• Default: 8
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

marker.pattern.solidity number

Fraction of the area the pattern covers: 0 shows only the background, 1 only the pattern color, or one per cell.

• Type: number from 0 to 1
• Default: 0.3
• Array OK: yes (one value per point)
• Edit type: style
• Animatable: no

leaf

Leaf style.

• Type: object
• Edit type: plot

leaf.opacity number

Opacity of the leaves (nodes without children). Default 1 with a colorscale, else 0.7.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: style
• Animatable: no

root

Root style.

• Type: object
• Edit type: calc

root.color color

Color of the root node (transparent by default).

• Type: color
• Default: "rgba(0, 0, 0, 0)"
• Array OK: no
• Edit type: calc
• Animatable: no

sort boolean

Order siblings by value, largest first; otherwise in data order.

• Type: boolean
• Default: true
• Array OK: no
• Edit type: calc
• Animatable: no

pathbar

The path bar: where the current root sits in the hierarchy.

• Type: object
• Edit type: calc

pathbar.visible boolean

Whether the path bar is drawn: the ancestors of the current root (level) as a bar outside the domain, one pixel away. Clicking a segment goes up to it.

• Type: boolean
• Default: true
• Array OK: no
• Edit type: plot
• Animatable: no

pathbar.side enumerated

Side of the chart the path bar is on.

• Type: enumerated
• Values: "top" | "bottom"
• Default: "top"
• Array OK: no
• Edit type: plot
• Animatable: no

pathbar.edgeshape enumerated

Shape of the edges between path bar segments.

• Type: enumerated
• Values: ">" | "<" | "|" | "/" | "\\"
• Default: ">"
• Array OK: no
• Edit type: plot
• Animatable: no

pathbar.thickness number

Thickness of the path bar in px. Default: pathbar.textfont.size plus 3 px on each side.

• Type: number ≥ 12
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

pathbar.textfont

Font of path bar labels. Defaults to textfont, with a color contrasting the segment.

• Type: object
• Edit type: plot

pathbar.textfont.family string

CSS font-family list.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

pathbar.textfont.size number

Font size in CSS px, or one per node.

• Type: number ≥ 1
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

pathbar.textfont.color color

Text color, or one per node.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

pathbar.textfont.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

pathbar.textfont.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

text data_array

Text per cell, shown with the text flag of textinfo, and in hover labels unless hovertext is set.

• Type: data_array (array or typed array)
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

textinfo flaglist

What node labels show, one per line in a fixed order: label, value, current path, the percentages (of the parent, the entry, the root; '25% of parent' when several), text. Default 'label', 'text+label' when text is an array. Use texttemplate for other layouts.

• Type: flaglist
• Flags: "label", "text", "value", "current path", "percent root", "percent entry", "percent parent" (combine with +)
• Also accepts: "none"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

texttemplate string

Template for node labels, overriding textinfo: %{label}, %{value}, %{currentPath}, %{percentParent}, %{parent}, %{percentEntry}, %{entry}, %{percentRoot}, %{root}, %{text}, %{color}, %{customdata}, %{meta}, with optional d3 formats (%{percentRoot:.1%}).

• Type: string
• Default: ""
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

textfont

Font of node labels. Defaults to layout.font.

• Type: object
• Edit type: plot

textfont.family string

CSS font-family list.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

textfont.size number

Font size in CSS px, or one per node.

• Type: number ≥ 1
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

textfont.color color

Text color, or one per node.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

textfont.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

textfont.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

insidetextfont

Font of labels inside nodes. Defaults to textfont, with a color contrasting the node.

• Type: object
• Edit type: plot

insidetextfont.family string

CSS font-family list.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

insidetextfont.size number

Font size in CSS px, or one per node.

• Type: number ≥ 1
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

insidetextfont.color color

Text color, or one per node.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

insidetextfont.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

insidetextfont.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

outsidetextfont

Font of the root's label when the root is transparent (it sits on the background; not with a colorscale or several roots). Defaults to textfont.

• Type: object
• Edit type: plot

outsidetextfont.family string

CSS font-family list.

• Type: string (non-empty)
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

outsidetextfont.size number

Font size in CSS px, or one per node.

• Type: number ≥ 1
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

outsidetextfont.color color

Text color, or one per node.

• Type: color
• Default: none
• Array OK: yes (one value per point)
• Edit type: plot
• Animatable: no

outsidetextfont.weight integer

Font weight: a CSS numeric weight (1–1000), normal or bold.

• Type: integer from 1 to 1000, or "normal" | "bold"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

outsidetextfont.style enumerated

Font style.

• Type: enumerated
• Values: "normal" | "italic"
• Default: none
• Array OK: no
• Edit type: plot
• Animatable: no

textposition enumerated

Where labels sit in their tiles. Branch labels (headers) sit in the top padding, or the bottom one for the bottom positions.

• Type: enumerated
• Values: "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right"
• Default: "top left"
• Array OK: no
• Edit type: plot
• Animatable: no

depth any

Extrusion toward the viewer (Holochart extension, 2.5D): CSS px, a percentage of each shape's width ('60%'), or one number per item. 0 (default) draws the trace flat. Seen in perspective with layout.view3d; in the flat view extruded shapes are lit from the front.

• Type: any
• Default: 0
• Array OK: no
• Edit type: plot
• Animatable: no

bevel

Rounded edges of extruded shapes (with depth).

• Type: object
• Edit type: plot

bevel.size number

Radius of the rounded front and side edges, CSS px (at most half the size).

• Type: number ≥ 0
• Default: 0
• Array OK: no
• Edit type: plot
• Animatable: no

bevel.segments integer

Segments of each rounded edge.

• Type: integer from 1 to 16
• Default: 3
• Array OK: no
• Edit type: plot
• Animatable: no

material

The material of extruded shapes (with depth): Plotly figures keep the default, plotly.

• Type: object
• Edit type: calc

material.type enumerated

How surfaces are shaded. plotly: Plotly's lighting model. flat: unlit, colors as given. basic, lambert, phong, standard, physical, toon, matcap: the three.js material of that name, lit by the lights of the scene (scene.lighting) or of the 2.5D view.

• Type: enumerated
• Values: "plotly" | "flat" | "basic" | "lambert" | "phong" | "standard" | "physical" | "toon" | "matcap"
• Default: "plotly"
• Array OK: no
• Edit type: calc
• Animatable: no

material.roughness number

Surface roughness (standard, physical). Default: lighting.roughness.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.metalness number

How metallic the surface is (standard, physical). Default 0.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.shininess number

Sharpness of the highlights (phong). Default: from lighting.roughness.

• Type: number ≥ 0
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.specular color

Color of the highlights (phong). Default: lighting.specular gray.

• Type: color
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.emissive color

Color the surface emits regardless of the lights. Default black.

• Type: color
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.emissiveintensity number

Strength of emissive. Default 1.

• Type: number ≥ 0
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.reflectivity number

How much the environment is reflected (basic, lambert, phong, physical).

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.envmapintensity number

Strength of the environment's light (standard, physical). Default 1.

• Type: number ≥ 0
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.clearcoat number

A clear lacquer layer (physical). Default 0.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.clearcoatroughness number

Roughness of the clear coat (physical). Default 0.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.transmission number

Transmission, for glass-like surfaces (physical). Default 0.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.ior number

Index of refraction (physical). Default 1.5.

• Type: number from 1 to 2.333
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.thickness number

Thickness of transmissive volumes, scene units (physical).

• Type: number ≥ 0
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.sheen number

Velvet-like sheen (physical). Default 0.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.sheencolor color

Color of the sheen (physical).

• Type: color
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.sheenroughness number

Roughness of the sheen (physical). Default 1.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.iridescence number

Thin-film iridescence (physical). Default 0.

• Type: number from 0 to 1
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.steps integer

Number of shading bands (toon).

• Type: integer from 2 to 16
• Default: 3
• Array OK: no
• Edit type: calc
• Animatable: no

material.matcap string

URL of a matcap image (matcap): the surface takes its colors from it by normal direction.

• Type: string
• Default: none
• Array OK: no
• Edit type: calc
• Animatable: no

material.castshadow boolean

Cast shadows from the lights of scene.lighting with castshadow (onto three.js material types and the ground plane).

• Type: boolean
• Default: false
• Array OK: no
• Edit type: calc
• Animatable: no

material.receiveshadow boolean

Receive shadows (three.js material types only).

• Type: boolean
• Default: false
• Array OK: no
• Edit type: calc
• Animatable: no

tilt number

Tilt of the trace in 2.5D (Holochart extension), degrees: positive looks from above, 0 (default) is the flat view. With depth, slices and tiles show their sides.

• Type: number from -80 to 80
• Default: 0
• Array OK: no
• Edit type: plot
• Animatable: yes

perspective number

Strength of the perspective of a tilted or extruded trace: 0 is a parallel projection, 1 a strong one.

• Type: number from 0 to 1
• Default: 0.5
• Array OK: no
• Edit type: plot
• Animatable: yes