Skip to content

histogram attributes ​

Histograms: samples binned into bars (counts, sums, averages, min or max per bin), normalized or cumulative, vertical or horizontal, grouped or stacked with bars (layout.barmode).

  • Categories: cartesian, bar-like, histogram, showLegend, errorBarsOK
  • Plotly equivalent: histogram
  • Guide: histogram chart page
  • Used in examples: demos/dallas-weather/rain-histogram, demos/dallas-weather/temp-histogram, demos/index-funds/returns-histogram, demos/science-basics/discovery, demos/science-basics/gas-speeds, demos/tqqq-soxl/returns-histogram, histogram/basic, histogram/cumulative, histogram/date-months, histogram/histfunc, histogram/horizontal, histogram/normalized, histogram/overlay, histogram/patterns, histogram/stacked-bars

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

Attribute tree

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 ​

Samples binned along x (vertical bars when only x is given): numbers, dates or category names depending on the axis type. With both x and y, the coordinate across the bars is what histfunc aggregates.

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

y data_array ​

Samples binned along y (horizontal bars when only y is given): numbers, dates or category names depending on the axis type. With both x and y, the coordinate across the bars is what histfunc aggregates.

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

orientation enumerated ​

'v': bin x into vertical bars; 'h': bin y into horizontal bars. Defaults to 'h' when only y is given.

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

histfunc enumerated ​

What each bar shows: the number of samples in the bin (count), or the sum, average (avg), min or max of the other coordinate (y for vertical histograms) over the bin. Needs both coordinates for anything but count.

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

histnorm enumerated ​

Normalization: '' the raw values; percent / probability the share of the total (bar heights sum to 100 / 1); density the value per unit of bin width (bar areas sum to the total; per ms on date axes); probability density the share per unit width (bar areas sum to 1).

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

cumulative ​

Cumulative histograms.

  • Type: object
  • Edit type: calc

cumulative.enabled boolean ​

Show the cumulative distribution: each bar sums the bins before it. With a density norm it behaves like the norm without density (it rises to the total or to 1).

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

cumulative.direction enumerated ​

increasing: sum the bins to the left (rising); decreasing: sum the bins to the right.

  • Type: enumerated
  • Values: "increasing" | "decreasing"
  • Default: "increasing"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

cumulative.currentbin enumerated ​

Whether a bar counts its own bin (include, a half-bin bias), not at all (exclude, the opposite bias) or half of it (half, no bias).

  • Type: enumerated
  • Values: "include" | "exclude" | "half"
  • Default: "include"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

nbinsx integer ​

Maximum number of bins along x: the bin size is the next round size giving at most this many. 0: automatic. Ignored when xbins.size is set.

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

xbins ​

Bins along x. Unset parts are automatic; traces of one bingroup share them.

  • Type: object
  • Edit type: calc

xbins.start any ​

First bin edge along x. Default: the data minimum moved down to a round value, off the data (integer data in bins of 5 starts at -0.5, so 0–4 fall in the first bin). A date string on date axes, a category index (e.g. -0.5) on category axes. In a bin group, the first explicit start wins and the other traces' starts are moved down onto its bin grid.

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

xbins.end any ​

Where binning stops along x: bins are added from start by size until one reaches or passes end. Default: the data maximum.

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

xbins.size any ​

Bin width along x. Default: a round size giving about as many bins as samples per bin (with nbinsx: at most that many bins). On date axes, ms or 'M<n>' for months ('M1', 'M3' quarters, 'M12' years); on category axes, the number of categories per bin (default 1).

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

nbinsy integer ​

Maximum number of bins along y (horizontal histograms), see nbinsx. Ignored when ybins.size is set.

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

ybins ​

Bins along y. Unset parts are automatic; traces of one bingroup share them.

  • Type: object
  • Edit type: calc

ybins.start any ​

First bin edge along y. Default: the data minimum moved down to a round value, off the data (integer data in bins of 5 starts at -0.5, so 0–4 fall in the first bin). A date string on date axes, a category index (e.g. -0.5) on category axes. In a bin group, the first explicit start wins and the other traces' starts are moved down onto its bin grid.

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

ybins.end any ​

Where binning stops along y: bins are added from start by size until one reaches or passes end. Default: the data maximum.

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

ybins.size any ​

Bin width along y. Default: a round size giving about as many bins as samples per bin (with nbinsy: at most that many bins). On date axes, ms or 'M<n>' for months ('M1', 'M3' quarters, 'M12' years); on category axes, the number of categories per bin (default 1).

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

autobinx boolean ​

Obsolete (every bin attribute is automatic unless set): true ignores xbins and bins automatically.

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

autobiny boolean ​

Obsolete: true ignores ybins and bins automatically.

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

bingroup string ​

Histograms (and 2D histograms) with the same bin group share their bins, also across subplots on axes of one type. Under barmode stack or group, the histograms of a subplot and orientation always share bins.

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

offsetgroup string ​

Traces with the same offset group share one slot in group mode (and stack together in stack/relative modes); bars at the same position line up, also across subplots on the same position axis.

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

alignmentgroup string ​

Traces on the same position axis with the same alignment group split each position between their offset groups; different alignment groups lay out independently.

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

text string ​

Text per bar, drawn per textposition and shown in hover labels.

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

texttemplate string ​

Template for bar labels, overriding text: %{value} (bar length), %{label} (position), %{x}, %{y}, %{text}, %{customdata}, %{meta}, with optional d3 formats (%{value:.1f}) or date formats (%{x|%b %Y}).

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

textposition enumerated ​

Where bar labels go: inside (against the bar end, see insidetextanchor), outside (past the bar end; inner bars of a stack stay inside), auto (inside when it fits, else outside), none.

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

insidetextanchor enumerated ​

Where inside labels sit along the bar.

  • Type: enumerated
  • Values: "end" | "middle" | "start"
  • Default: "end"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

textangle angle ​

Label rotation in degrees, clockwise. 'auto' turns inside labels 90° when that fits the bar better.

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

textfont ​

Font of bar labels. Defaults to layout.font.

  • Type: object
  • Edit type: calc

textfont.family string ​

CSS font-family list.

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

textfont.size number ​

Font size in CSS px, or one per bar.

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

textfont.color color ​

Text color, or one per bar.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • 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: calc
  • Animatable: no

textfont.style enumerated ​

Font style.

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

insidetextfont ​

Font of labels inside bars. Defaults to textfont, with a color contrasting the bar fill.

  • Type: object
  • Edit type: calc

insidetextfont.family string ​

CSS font-family list.

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

insidetextfont.size number ​

Font size in CSS px, or one per bar.

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

insidetextfont.color color ​

Text color, or one per bar.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • 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: calc
  • Animatable: no

insidetextfont.style enumerated ​

Font style.

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

outsidetextfont ​

Font of labels outside bars. Defaults to textfont.

  • Type: object
  • Edit type: calc

outsidetextfont.family string ​

CSS font-family list.

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

outsidetextfont.size number ​

Font size in CSS px, or one per bar.

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

outsidetextfont.color color ​

Text color, or one per bar.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • 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: calc
  • Animatable: no

outsidetextfont.style enumerated ​

Font style.

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

constraintext enumerated ​

Shrink labels (inside, outside, or both) so they are no larger than their bar.

  • Type: enumerated
  • Values: "inside" | "outside" | "both" | "none"
  • Default: "both"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

zorder integer ​

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

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

cliponaxis boolean ​

Clip labels to the plot area. false is not drawn yet: labels are always clipped to the subplot.

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

marker ​

Bar style.

  • Type: object
  • Edit type: calc

marker.color color ​

Bar fill color, one per bar, or numbers mapped through colorscale. Defaults to the colorway.

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

marker.colorscale colorscale ​

Colorscale for numeric marker.color 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: style
  • 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: style
  • Animatable: no

marker.reversescale boolean ​

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

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

marker.cauto boolean ​

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

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

marker.opacity number ​

Bar opacity (multiplied by the trace opacity), or one per bar.

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

marker.cornerradius any ​

Corner radius in CSS px, or a percentage of the bar width ('30%'). Default: layout.barcornerradius. In stacks only the outermost bar is rounded.

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

marker.line ​

Bar outline.

  • Type: object
  • Edit type: style

marker.line.color color ​

Bar outline color, one per bar, or numbers mapped through its colorscale.

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

marker.line.colorscale colorscale ​

Colorscale for numeric marker.line.color 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: style
  • Animatable: no

marker.line.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: style
  • Animatable: no

marker.line.reversescale boolean ​

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

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

marker.line.cauto boolean ​

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

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

marker.line.cmin number ​

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

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

marker.line.cmax number ​

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

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

marker.line.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: style
  • Animatable: no

marker.line.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: style
  • Animatable: no

marker.line.width number ​

Bar outline width in CSS px (centered on the edge), or one per bar.

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

marker.pattern ​

Hatch pattern of the bar 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 bar.

  • 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 bar.

  • 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 bar.

  • 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 bar.

  • 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 bar.

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

error_x ​

Error bars along the x axis.

  • Type: object
  • Edit type: calc

error_x.visible boolean ​

Whether this set of error bars is visible. Defaults to true when array or value is given, or type is sqrt.

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

error_x.type enumerated ​

How the bar lengths are computed: 'percent' of the underlying value, a 'constant', the 'sqrt' of the value, or per-point 'data' (array / arrayminus). Defaults to 'data' when array is given, else 'percent'.

  • Type: enumerated
  • Values: "percent" | "constant" | "sqrt" | "data"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

error_x.symmetric boolean ​

Whether both directions use the same length. Defaults to true unless arrayminus (data) or valueminus (percent, constant) is given.

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

error_x.array data_array ​

Bar lengths in the positive x axis direction (or both directions when symmetric), one per point, for type 'data'.

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

error_x.arrayminus data_array ​

Bar lengths in the negative x axis direction, one per point, for type 'data' with symmetric: false.

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

error_x.value number ​

Bar length in the positive x axis direction (or both when symmetric): a percentage of the value for 'percent', an absolute length for 'constant'.

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

error_x.valueminus number ​

Bar length in the negative x axis direction when symmetric is false (see value).

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

error_x.traceref integer ​

Accepted for Plotly compatibility; has no effect.

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

error_x.tracerefminus integer ​

Accepted for Plotly compatibility; has no effect.

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

error_x.thickness number ​

Stroke width of the bars and their end caps, in CSS px.

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

error_x.width number ​

Half-length of the cross-bar at each end, in CSS px (default 4). 0 hides the caps.

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

error_x.color color ​

Color of the bars. Defaults to the trace color.

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

error_x.copy_ystyle boolean ​

Use the error_y color, thickness and width. Defaults to true when error_y is visible and none of those is set here.

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

error_y ​

Error bars along the y axis.

  • Type: object
  • Edit type: calc

error_y.visible boolean ​

Whether this set of error bars is visible. Defaults to true when array or value is given, or type is sqrt.

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

error_y.type enumerated ​

How the bar lengths are computed: 'percent' of the underlying value, a 'constant', the 'sqrt' of the value, or per-point 'data' (array / arrayminus). Defaults to 'data' when array is given, else 'percent'.

  • Type: enumerated
  • Values: "percent" | "constant" | "sqrt" | "data"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

error_y.symmetric boolean ​

Whether both directions use the same length. Defaults to true unless arrayminus (data) or valueminus (percent, constant) is given.

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

error_y.array data_array ​

Bar lengths in the positive y axis direction (or both directions when symmetric), one per point, for type 'data'.

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

error_y.arrayminus data_array ​

Bar lengths in the negative y axis direction, one per point, for type 'data' with symmetric: false.

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

error_y.value number ​

Bar length in the positive y axis direction (or both when symmetric): a percentage of the value for 'percent', an absolute length for 'constant'.

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

error_y.valueminus number ​

Bar length in the negative y axis direction when symmetric is false (see value).

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

error_y.traceref integer ​

Accepted for Plotly compatibility; has no effect.

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

error_y.tracerefminus integer ​

Accepted for Plotly compatibility; has no effect.

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

error_y.thickness number ​

Stroke width of the bars and their end caps, in CSS px.

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

error_y.width number ​

Half-length of the cross-bar at each end, in CSS px (default 4). 0 hides the caps.

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

error_y.color color ​

Color of the bars. Defaults to the trace color.

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

selected ​

Style of selected bars while a selection is active.

  • Type: object
  • Edit type: style

selected.marker ​

Marker style of selected bars.

  • Type: object
  • Edit type: style

selected.marker.color color ​

Fill color of selected bars.

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

selected.marker.opacity number ​

Opacity of selected bars.

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

selected.textfont ​

Text style of selected bars.

  • Type: object
  • Edit type: style

selected.textfont.color color ​

Text color of selected bars.

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

unselected ​

Style of unselected bars while a selection is active.

  • Type: object
  • Edit type: style

unselected.marker ​

Marker style of unselected bars.

  • Type: object
  • Edit type: style

unselected.marker.color color ​

Fill color of unselected bars.

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

unselected.marker.opacity number ​

Opacity of unselected bars. Default: 0.2 × the bar opacity.

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

unselected.textfont ​

Text style of unselected bars.

  • Type: object
  • Edit type: style

unselected.textfont.color color ​

Text color of unselected bars.

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

Released under the MIT License.