histogram2dcontour attributes

2D density contours: samples binned along x and y, drawn as filled contour bands, a smoothed heatmap or level lines, with labels along the lines.

• Categories: cartesian, 2dMap, histogram, contour, showLegend
• Plotly equivalent: histogram2dcontour
• Guide: histogram2dcontour chart page
• Used in examples: demos/index-funds/density, demos/science-basics/electron-cloud, demos/tqqq-soxl/daily-leverage, histogram2dcontour/bands, histogram2dcontour/constraint, histogram2dcontour/filled, histogram2dcontour/heatmap, histogram2dcontour/lines-labels, histogram2dcontour/over-scatter

Generated from the attribute schema (176 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
• xaxis
• yaxis
• x
• y
• z
• marker

  • color
• histfunc
• histnorm
• nbinsx
• xbins

  • start
  • end
  • size
• nbinsy
• ybins

  • start
  • end
  • size
• autobinx
• autobiny
• bingroup
• xbingroup
• ybingroup
• xhoverformat
• yhoverformat
• zhoverformat
• autocontour
• ncontours
• contours

  • type
  • start
  • end
  • size
  • coloring
  • showlines
  • showlabels
  • labelfont

    • family
    • size
    • color
    • weight
    • style
    • variant
    • textcase
    • lineposition
    • shadow
  • labelformat
  • operation
  • value
• fillcolor
• line

  • color
  • width
  • dash
  • smoothing
• texttemplate
• textfont

  • family
  • size
  • color
  • weight
  • style
• zorder
• zauto
• zmin
• zmax
• zmid
• colorscale
• autocolorscale
• reversescale
• 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

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; 'skip' also turns hover events off for this trace. Default 'all'.

• Type: flaglist
• Flags: "x", "y", "z", "text", "name" (combine with +)
• Also accepts: "all" | "none" | "skip"
• Default: none
• 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

xaxis subplotid

The x axis this trace is plotted against: 'x' → layout.xaxis, 'x2' → layout.xaxis2.

• Type: subplotid (x, x2, x3, …)
• Default: "x"
• Array OK: no
• Edit type: calc
• Animatable: no

yaxis subplotid

The y axis this trace is plotted against: 'y' → layout.yaxis, 'y2' → layout.yaxis2.

• Type: subplotid (y, y2, y3, …)
• Default: "y"
• Array OK: no
• Edit type: calc
• Animatable: no

x data_array

Sample x coordinates (numbers, dates or categories), binned along x. Required, with y.

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

y data_array

Sample y coordinates (numbers, dates or categories), binned along y. Required, with x.

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

z data_array

Values aggregated by histfunc (one per sample); counts are used without.

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

marker

Aggregation data (Plotly compatibility).

• Type: object
• Edit type: calc

marker.color data_array

Aggregation values, used when z is not given.

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

histfunc enumerated

What each bin shows: the number of samples (count), or the sum, average (avg), min or max of their z values.

• Type: enumerated
• Values: "count" | "sum" | "avg" | "min" | "max"
• Default: "count"
• Array OK: no
• Edit type: calc
• Animatable: no

histnorm enumerated

Normalization: none, the percentage or fraction of the total (percent, probability), per unit area (density: value / bin area), or both (probability density, integrating to 1).

• Type: enumerated
• Values: "" | "percent" | "probability" | "density" | "probability density"
• Default: ""
• Array OK: no
• Edit type: calc
• Animatable: no

nbinsx integer

Maximum number of x bins when xbins.size is not given (a nice round size is picked). 0: automatic.

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

xbins

X binning.

• Type: object
• Edit type: calc

xbins.start any

First x bin edge. Default: the smallest sample, shifted down to a nice round value (integers get edges at half-integers). Dates as date strings; categories by their serial number (default -0.5).

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

xbins.end any

Where x bins stop: edges step by size from start until they reach or pass end. Default: the largest sample.

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

xbins.size any

Width of the x bins: a number, milliseconds or 'M<n>' (months) on date axes, a number of categories on category axes. Default: a nice round size from nbinsx or the samples.

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

nbinsy integer

Maximum number of y bins when ybins.size is not given (a nice round size is picked). 0: automatic.

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

ybins

Y binning.

• Type: object
• Edit type: calc

ybins.start any

First y bin edge. Default: the smallest sample, shifted down to a nice round value (integers get edges at half-integers). Dates as date strings; categories by their serial number (default -0.5).

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

ybins.end any

Where y bins stop: edges step by size from start until they reach or pass end. Default: the largest sample.

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

ybins.size any

Width of the y bins: a number, milliseconds or 'M<n>' (months) on date axes, a number of categories on category axes. Default: a nice round size from nbinsy or the samples.

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

autobinx boolean

Obsolete (Plotly compatibility): bins are automatic unless xbins sets them.

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

autobiny boolean

Obsolete (Plotly compatibility): bins are automatic unless ybins sets them.

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

bingroup string

Default of xbingroup and ybingroup (suffixed per direction): traces with the same bingroup get matching x bins and matching y bins.

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

xbingroup string

Traces (histogram2d, histogram2dcontour, and histograms with the same bingroup) on axes of the same type with the same group share their x bins.

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

ybingroup string

Like xbingroup, for y bins.

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

xhoverformat string

d3 number or date format of x values in hover labels. Default: the axis format.

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

yhoverformat string

d3 number or date format of y values in hover labels. Default: the axis format.

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

zhoverformat string

d3 number format of z values in hover labels (and %{z} in templates).

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

autocontour boolean

Pick the contour levels automatically (at most ncontours, at nice round values). Defaults to false when contours.start and contours.end are given.

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

ncontours integer

Maximum number of contour levels with autocontour (or without contours.size); the actual number is chosen to give nice round levels.

• Type: integer ≥ 1
• Default: 15
• Array OK: no
• Edit type: calc
• Animatable: no

contours

Contour levels, coloring, labels and constraints.

• Type: object
• Edit type: calc

contours.type enumerated

'levels': lines (and fills) at every level. 'constraint': the boundary of the region where z satisfies operation and value, with the region shaded in fillcolor for inequalities.

• Type: enumerated
• Values: "levels" | "constraint"
• Default: "levels"
• Array OK: no
• Edit type: calc
• Animatable: no

contours.start number

First contour level (with end, turns autocontour off).

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

contours.end number

Last contour level (with start, turns autocontour off).

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

contours.size number

Step between contour levels. Default: a nice round step from ncontours.

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

contours.coloring enumerated

How levels are colored: flat bands between levels ('fill'), a smooth heatmap under the lines ('heatmap'), colored lines only ('lines'), or plain line.color lines ('none'). Not used by constraint contours.

• Type: enumerated
• Values: "fill" | "heatmap" | "lines" | "none"
• Default: "fill"
• Array OK: no
• Edit type: calc
• Animatable: no

contours.showlines boolean

Draw the contour lines (only for coloring: 'fill' and shaded constraints; always drawn otherwise).

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

contours.showlabels boolean

Label contour lines with their level, along the lines (the lines break under the labels).

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

contours.labelfont

Font of the level labels. Defaults to layout.font, colored like the lines.

• Type: object
• Edit type: layout+plot

contours.labelfont.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

contours.labelfont.size number

Font size in CSS pixels.

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

contours.labelfont.color color

Text color.

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

contours.labelfont.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

contours.labelfont.style enumerated

Font style.

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

contours.labelfont.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

contours.labelfont.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

contours.labelfont.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

contours.labelfont.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

contours.labelformat string

d3 number format of the level labels, e.g. .2f. Default: automatic.

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

contours.operation enumerated

Constraint contours: '=' draws the line where z equals value; '<' / '<=' and '>' / '>=' shade where z is below or above value; '[]', '()', '[)', '(]' shade inside the interval value, '][', ')(', '](', ')[' outside it. Open and closed ends draw the same.

• Type: enumerated
• Values: "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")["
• Default: "="
• Array OK: no
• Edit type: calc
• Animatable: no

contours.value any

Constraint contours: the boundary value, a number for comparisons, or [lower, upper] for intervals (a single number v means [v, v + 1]).

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

fillcolor color

Fill of the shaded region of constraint contours. Default: line.color (else the trace's colorway color) at half opacity.

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

line

Contour lines.

• Type: object
• Edit type: plot

line.color color

Contour line color. Default: black; lines take their level's color with coloring: 'lines'. Constraint contours default to fillcolor made opaque.

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

line.width number

Contour line width in px (default 0.5, or 2 for constraint contours).

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

line.dash string

Dash style: 'solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot', or a dash list such as '5px,10px,2px'.

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

line.smoothing number

Smoothing of the contour lines and fills (Plotly’s spline smoothing): 0 draws straight segments between grid crossings.

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

texttemplate string

Label drawn in every bin with contours.coloring: 'heatmap': %{z}, %{x}, %{y} with optional d3 formats. Empty: no labels.

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

textfont

Font of the cell labels (texttemplate).

• Type: object
• Edit type: plot

textfont.family string

CSS font-family list. Default: layout.font.family.

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

textfont.size number

Font size in CSS px, or 'auto': the largest size (up to layout.font.size) at which labels fit their cells.

• Type: number ≥ 1, or "auto"
• Default: "auto"
• Array OK: no
• Edit type: plot
• Animatable: no

textfont.color color

Text color. Default: black or white, whichever contrasts with the cell.

• Type: color
• Default: none
• Array OK: no
• Edit type: style
• 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

zorder integer

Stacking order among the traces of a subplot: higher is drawn on top. At equal zorder, contours draw below bars and scatter traces (Plotly’s layer order).

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

zauto boolean

Compute the color domain from the aggregated values. Defaults to false when both zmin and zmax are given.

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

zmin number

Value mapped to the first colorscale color (with zmax; turns zauto off).

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

zmax number

Value mapped to the last colorscale color (with zmin; turns zauto off).

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

zmid number

With zauto, 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

colorscale colorscale

Colorscale of the aggregated values: a name ('Viridis', 'RdBu', …), a list of colors, or [position, color] stops from 0 to 1. Default: Plotly's RdBu; the default holochart template uses its sequential neon plasma.

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

autocolorscale boolean

Pick the colorscale from the sign of the color domain (layout.colorscale.sequential, sequentialminus or diverging). Defaults to true unless colorscale is given.

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

reversescale boolean

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

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

showscale boolean

Show a colorbar for the colorscale (drawn by the colorbar component).

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

colorbar

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

• Type: object
• Edit type: colorbars+layout

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

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

colorbar.thickness number

Thickness of the color bar.

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

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

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

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

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

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

colorbar.xpad number

Horizontal padding, px.

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

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

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

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

colorbar.ypad number

Vertical padding, px.

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

colorbar.outlinecolor color

Color of the outline around the bar.

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

colorbar.outlinewidth number

Outline width, px.

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

colorbar.bordercolor color

Border color of the colorbar box.

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

colorbar.borderwidth number

Border width of the box, px.

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

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

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

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

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

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

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

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

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

colorbar.ticklen number

Tick length in px.

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

colorbar.tickwidth number

Tick width in px.

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

colorbar.tickcolor color

Tick color. Defaults to color.

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

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

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

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

colorbar.showticklabels boolean

Show tick labels.

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

colorbar.tickfont

Tick-label font. Defaults to layout.font.

• Type: object
• Edit type: layout+plot

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

colorbar.tickfont.size number

Font size in CSS pixels.

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

colorbar.tickfont.color color

Text color.

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

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

colorbar.tickfont.style enumerated

Font style.

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

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

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

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

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

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

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

colorbar.tickprefix string

Text before each tick label.

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

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

colorbar.ticksuffix string

Text after each tick label.

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

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

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

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

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

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

colorbar.title

Colorbar title.

• Type: object
• Edit type: colorbars+layout

colorbar.title.text string

Colorbar title.

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

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

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

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

colorbar.title.font.color color

Text color.

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

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

colorbar.title.font.style enumerated

Font style.

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

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

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

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

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

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

coloraxis subplotid

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

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