Holochart

Layout attributes ​

Attributes of layout: figure size, margins, fonts, axes, subplots and components. Trace modules and components registered with the chart add their own layout attributes, which are included here.

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

Attribute tree

width number ​

Figure width in CSS pixels. Ignored when autosize fills the container.

  • Type: number ≥ 10
  • Default: 700
  • Array OK: no
  • Edit type: layout
  • Animatable: no

height number ​

Figure height in CSS pixels. Ignored when autosize fills the container.

  • Type: number ≥ 10
  • Default: 450
  • Array OK: no
  • Edit type: layout
  • Animatable: no

autosize boolean ​

Size the figure to its container on first render (and on resize with config.responsive).

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

margin ​

Space around the plot area.

  • Type: object
  • Edit type: layout

margin.l number ​

Left margin in CSS pixels.

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

margin.r number ​

Right margin in CSS pixels.

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

margin.t number ​

Top margin in CSS pixels.

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

margin.b number ​

Bottom margin in CSS pixels.

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

margin.pad number ​

Padding between the plot area and the axis lines, in CSS pixels.

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

margin.autoexpand boolean ​

Let components (legend, colorbars, automargin axes) grow the margins.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

margin.gutter number ​

Holochart extension: space (CSS px) kept between the figure edge and content that grows a margin (automargin tick labels and axis titles, legends, colorbars), so it never touches the edge. 0 (Plotly) lets that content reach the edge.

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

paper_bgcolor color ​

Background color of the whole figure.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: style
  • Animatable: no

plot_bgcolor color ​

Background color of the plot area between the axes.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: style
  • Animatable: no

font ​

Global font. Every text element inherits unset font fields from here.

  • Type: object
  • Edit type: layout+plot

font.family string ​

CSS font-family list used by every text element unless overridden.

  • Type: string (non-empty)
  • Default: "\"Open Sans\", verdana, arial, sans-serif"
  • Array OK: no
  • Edit type: layout+plot (inherited)
  • Animatable: no

font.size number ​

Base font size in CSS pixels.

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

font.color color ​

Base text color.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: style
  • Animatable: no

font.weight integer ​

Base font weight.

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

font.style enumerated ​

Base font style.

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

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: "normal"
  • Array OK: no
  • Edit type: layout+plot (inherited)
  • Animatable: no

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: "normal"
  • Array OK: no
  • Edit type: layout+plot (inherited)
  • Animatable: no

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

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

colorway colorlist ​

Default trace colors, cycled by trace index. A registered colorway's name works too, e.g. 'Safe' (colorblind-safe, always available; Holochart only).

  • Type: colorlist
  • Default: ["#1f77b4", "#ff7f0e", "#2ca02c", "#d62728", "#9467bd", "#8c564b", "#e377c2", "#7f7f7f", "#bcbd22", "#17becf"]
  • Array OK: no
  • Edit type: style+legend
  • Animatable: no

template any ​

Template: a registered name ('dark'), a +-composition ('dark+presentation') or an object { layout, data }. null disables the default template.

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

title ​

Figure title.

  • Type: object
  • Edit type: layout+plot

title.text string ​

Title text (supports rich-text tags, E2.10).

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

title.font ​

Title font. Defaults to layout.font with 1.4× size.

  • Type: object
  • Edit type: layout+plot

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

title.font.size number ​

Font size in CSS pixels.

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

title.font.color color ​

Text color.

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

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

title.font.style enumerated ​

Font style.

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

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

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

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

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

title.x number ​

Horizontal position in xref coordinates.

  • Type: number from 0 to 1
  • Default: 0.5
  • Array OK: no
  • Edit type: layout+plot (inherited)
  • Animatable: no

title.y number ​

Vertical position in yref coordinates. auto places it in the top margin.

  • Type: number from 0 to 1, or "auto"
  • Default: "auto"
  • Array OK: no
  • Edit type: layout+plot (inherited)
  • Animatable: no

title.xref enumerated ​

container spans the whole figure; paper spans the plot area.

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

title.yref enumerated ​

container spans the whole figure; paper spans the plot area.

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

title.xanchor enumerated ​

Horizontal alignment of the title box relative to x.

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

title.yanchor enumerated ​

Vertical alignment of the title box relative to y.

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

title.subtitle ​

Subtitle.

  • Type: object
  • Edit type: layout+plot

title.subtitle.text string ​

Subtitle text, drawn below the title.

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

title.subtitle.font ​

Subtitle font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

title.subtitle.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

title.subtitle.font.size number ​

Font size in CSS pixels.

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

title.subtitle.font.color color ​

Text color.

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

title.subtitle.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

title.subtitle.font.style enumerated ​

Font style.

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

title.subtitle.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

title.subtitle.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

title.subtitle.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

title.subtitle.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

title.pad ​

Padding between the title and its anchor, applied on the anchored side only.

  • Type: object
  • Edit type: layout+plot

title.pad.t number ​

Padding above the title, px (yanchor: top).

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

title.pad.r number ​

Padding right of the title, px (xanchor: right).

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

title.pad.b number ​

Padding below the title, px (yanchor: bottom).

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

title.pad.l number ​

Padding left of the title, px (xanchor: left).

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

title.automargin boolean ​

Grow the top margin so the title (and subtitle) fit. With yref: paper the title then sits right above the plot area.

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

showlegend boolean ​

Show the legend. Defaults to true when more than one trace has a legend entry.

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

uniformtext ​

Uniform text sizing for bar and pie labels (E4.6).

  • Type: object
  • Edit type: plot

uniformtext.mode enumerated ​

Uniform size for the text inside bars and pie slices, per trace type (E4.6): labels are drawn at the smallest fitted size; hide drops labels that would be smaller than minsize, show draws them at the uniform size. false lets every label scale on its own.

  • Type: enumerated
  • Values: false | "hide" | "show"
  • Default: false
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

uniformtext.minsize number ​

Minimum text size in px for uniformtext.mode. Also raises trace fonts smaller than it.

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

hovermode enumerated ​

How hover picks points: nearest point, all points at the same x/y, or unified labels.

  • Type: enumerated
  • Values: "x" | "y" | "closest" | false | "x unified" | "y unified"
  • Default: "closest"
  • Array OK: no
  • Edit type: modebar
  • Animatable: no

dragmode enumerated ​

What dragging on the plot area does: zoom, pan, box or lasso select, or draw a new shape (draw*, styled by newshape).

  • Type: enumerated
  • Values: "zoom" | "pan" | "select" | "lasso" | "drawclosedpath" | "drawopenpath" | "drawline" | "drawrect" | "drawcircle" | "orbit" | "turntable" | false
  • Default: "zoom"
  • Array OK: no
  • Edit type: modebar
  • Animatable: no

transition ​

Default transition for animated updates (E7.3).

  • Type: object
  • Edit type: none

transition.duration number ​

Transition duration in milliseconds.

  • Type: number ≥ 0
  • Default: 500
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

transition.easing enumerated ​

Easing function.

  • Type: enumerated
  • Values: "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out"
  • Default: "cubic-in-out"
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

transition.ordering enumerated ​

Whether layout or trace changes animate first.

  • Type: enumerated
  • Values: "layout first" | "traces first"
  • Default: "layout first"
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

uirevision any ​

While unchanged across updates, user interaction state (zoom, legend toggles, selections) is preserved.

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

datarevision any ​

Change this to force data arrays to be re-read when they are mutated in place.

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

separators string ​

Decimal then thousands separator of numbers, e.g. ', ' for 1 234,5. Default: the locale's (config.locale), '.,' in English.

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

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

grid ​

A grid of subplots (Plotly layout.grid). Cartesian axes placed in the grid get their domain, anchor, side and position defaults from their cell; domain traces (pie, …) are placed with domain.row / domain.column. Values given on an axis or a trace always win.

  • Type: object
  • Edit type: calc

grid.rows integer ​

Number of rows. Defaults to the length of subplots or yaxes. A grid needs more than one cell (rows * columns > 1); otherwise it is ignored.

  • Type: integer from 1 to 100
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.roworder enumerated ​

Whether row 0 (of subplots, yaxes and trace domain.row) is the top row or the bottom row.

  • Type: enumerated
  • Values: "top to bottom" | "bottom to top"
  • Default: "top to bottom"
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.columns integer ​

Number of columns. Defaults to the length of subplots[0] or xaxes.

  • Type: integer from 1 to 100
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.subplots info_array ​

The cartesian subplot of each cell, as a 2D array [row][column] of ids like 'xy' or 'x2y3', or '' for an empty cell. All cells of a column must share one x axis and all cells of a row one y axis; a subplot that breaks this, or that no trace or axis creates, leaves its cell empty. Takes precedence over xaxes/yaxes. With pattern: 'independent' and no arrays, it defaults to 'xy', 'x2y2', … in row-major order.

  • Type: info_array [info_array, …]
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.xaxes info_array ​

The x axis of each column ('x', 'x2', …, or '' for none), used when there is no subplots array. Defaults to 'x', 'x2', … for pattern: 'coupled'.

  • Type: info_array [string, …]
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.yaxes info_array ​

The y axis of each row ('y', 'y2', …, or '' for none), used when there is no subplots array. Defaults to 'y', 'y2', … for pattern: 'coupled'.

  • Type: info_array [string, …]
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.pattern enumerated ​

Default cell contents when neither subplots nor xaxes/yaxes is given: coupled shares one x axis per column and one y axis per row (xaxes: ['x', 'x2', …], yaxes: ['y', 'y2', …]); independent gives every cell its own pair ('xy', 'x2y2', … in row-major order).

  • Type: enumerated
  • Values: "independent" | "coupled"
  • Default: "coupled"
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.xgap number ​

Horizontal space between columns, as a fraction of a column width. Defaults to 0.2 for a grid of independent subplots (subplots or pattern: independent), 0.1 otherwise.

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

grid.ygap number ​

Vertical space between rows, as a fraction of a row height. Defaults to 0.3 for a grid of independent subplots (subplots or pattern: independent), 0.1 otherwise.

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

grid.domain ​

The part of the plot area the grid fills.

  • Type: object
  • Edit type: calc (inherited)

grid.domain.x info_array ​

Horizontal extent [start, end] of the whole grid, as fractions of the plot area. An empty or reversed extent falls back to [0, 1].

  • Type: info_array [number, number]
  • Default: [0, 1]
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.domain.y info_array ​

Vertical extent [start, end] of the whole grid, as fractions of the plot area (from the bottom). An empty or reversed extent falls back to [0, 1].

  • Type: info_array [number, number]
  • Default: [0, 1]
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

grid.xside enumerated ​

Where the x axes are drawn by default: bottom plot / top plot against the bottom-most / top-most subplot of their column; bottom / top at the bottom / top edge of the grid (anchor: 'free'), even when that cell is empty.

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

grid.yside enumerated ​

Where the y axes are drawn by default: left plot / right plot against the left-most / right-most subplot of their row; left / right at the left / right edge of the grid (anchor: 'free'), even when that cell is empty.

  • Type: enumerated
  • Values: "left" | "left plot" | "right plot" | "right"
  • Default: "left plot"
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

xaxis ​

A x axis. xaxis2, xaxis3, … declare further x axes, referenced from traces as 'x2', 'x3', ….

  • Type: object
  • Subplots: also xaxis2, xaxis3, … for subplot ids x2, x3, …
  • Edit type: calc

xaxis.visible boolean ​

Draw the axis (line, ticks, labels, grid and title). A hidden axis still maps data to pixels.

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

xaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

xaxis.type enumerated ​

Axis type. '-' detects the type from the data of the first trace on this axis (Plotly's rules: mostly dates → date; more than twice as many distinct strings as numbers → category; two-level [[groups], [items]] arrays → multicategory; otherwise linear).

  • Type: enumerated
  • Values: "-" | "linear" | "log" | "date" | "category" | "multicategory"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

xaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

xaxis.autorange enumerated ​

Whether the range is computed from the data. reversed autoranges with the axis flipped. min/max autorange only that end and take the other from range (min reversed/max reversed also flip the axis). Defaults to false when a full range is given, to min/max when one end of range is null, and to reversed on a y axis only image traces use (row 0 at the top, as in Plotly).

  • Type: enumerated
  • Values: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max"
  • Default: true
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.autorangeoptions ​

Constraints applied to the computed autorange.

  • Type: object
  • Edit type: layout+ticks+plot

xaxis.autorangeoptions.minallowed any ​

The autoranged minimum is exactly this value (data units).

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

xaxis.autorangeoptions.maxallowed any ​

The autoranged maximum is exactly this value (data units).

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

xaxis.autorangeoptions.clipmin any ​

The autoranged minimum is at least this value (data units).

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

xaxis.autorangeoptions.clipmax any ​

The autoranged maximum is at most this value (data units).

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

xaxis.autorangeoptions.include any ​

Value(s) the autorange must include (data units).

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

xaxis.rangemode enumerated ​

Linear axes only. tozero extends the autorange to include 0; nonnegative keeps it ≥ 0.

  • Type: enumerated
  • Values: "normal" | "tozero" | "nonnegative"
  • Default: "normal"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.fixedrange boolean ​

Disables zoom and pan on this axis (drag, scroll, and modebar zoom leave its range alone).

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

xaxis.range info_array ​

Visible range [start, end] in data units (numbers, dates or category names; exponents on log axes, as in Plotly). Setting it turns autorange off; null for one end autoranges that end only.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: ticks+plot
  • Animatable: yes

xaxis.minallowed any ​

Lowest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

xaxis.maxallowed any ​

Highest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

xaxis.rangebreaks ​

Spans hidden from the axis (plan E3.8): the axis skips them, so a weekday-only stock chart has no gaps for weekends or nights. Date and linear axes; data inside a break is not drawn. Ticks never land in a break; hover, zoom and pan work across breaks.

  • Type: array of rangebreak objects; template defaults for every item go in rangebreakdefaults
  • Edit type: calc

xaxis.rangebreaks[].enabled boolean ​

Whether this range break is applied.

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

xaxis.rangebreaks[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template break; hidden breaks are ignored like disabled ones.

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

xaxis.rangebreaks[].bounds info_array ​

Lower and upper bound of the break. Without pattern: values in data units (['2024-01-06', '2024-01-08']). With pattern: 'day of week': day numbers 0–6 (Sunday = 0) or English day names (['sat', 'mon'] hides Saturday and Sunday). With pattern: 'hour': hours 0–24 ([17, 9] hides 17:00–09:00, wrapping past midnight). Patterns use UTC days and hours.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

xaxis.rangebreaks[].pattern enumerated ​

How bounds repeat: day of week or hour (date axes only), or '' for a single span. Defaults to day of week when bounds names days, else ''.

  • Type: enumerated
  • Values: "day of week" | "hour" | ""
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

xaxis.rangebreaks[].values info_array ​

Individual values to hide when no bounds are given, each hiding [value, value + dvalue) (e.g. holidays on a date axis).

  • Type: info_array [any, …], any length
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

xaxis.rangebreaks[].dvalue number ​

Size of each break in values, in data units (milliseconds on date axes). Default: one day.

  • Type: number ≥ 0
  • Default: 86400000
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

xaxis.rangebreaks[].name string ​

Name of this rangebreak, used to reference it from a template via templateitemname.

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

xaxis.rangebreaks[].templateitemname string ​

Name of a template rangebreak to inherit from. If no template item matches, this rangebreak is hidden (visible: false).

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

xaxis.domain info_array ​

Fraction of the plot area [start, end] this axis spans.

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

xaxis.anchor subplotid ​

The y axis this axis is drawn against, or free. Defaults to the y axis of the first subplot using this axis.

  • Type: subplotid (y, y2, y3, …)
  • Also accepts: "free"
  • Default: "y"
  • Array OK: no
  • Edit type: layout
  • Animatable: no

xaxis.side enumerated ​

Which side of the plot area the axis is drawn on.

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

xaxis.overlaying subplotid ​

Draw this axis over another x axis ('x', 'x2', …), sharing its domain (this axis' own domain is ignored), e.g. a secondary y axis with side: 'right'. Unset (or free) by default. The target must exist and must not overlay another axis itself; otherwise this is ignored. Templates cannot set it, since it names specific axes.

  • Type: subplotid (x, x2, x3, …)
  • Also accepts: "free"
  • Default: "x"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.position number ​

Position of the axis in paper coordinates (0–1 across the y direction). Only used when anchor is free.

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

xaxis.autoshift boolean ​

y axes with anchor: 'free' only: move the axis sideways so it does not overlap other free axes on the same side (and default position to the overlaid plot's edge, automargin to true, shift to ∓3 px). Plotly semantics.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.shift number ​

y axes with anchor: 'free' only: extra horizontal offset in px (negative to the left). Defaults to -3 on the left and 3 on the right when autoshift is on, else 0.

  • Type: number
  • Default: none
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.matches string ​

Link this axis' range to another axis of the same type ('x', 'x2', 'y', …): they autorange together over all their data, and zoom, pan and relayout of one move all. The linked axes share range, autorange, rangemode, rangebreaks, constrain and the category order. An axis that would create a loop, or a target of another type, is ignored.

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

xaxis.scaleanchor any ​

Lock the scale (px per unit) of this axis to another axis ('x', 'y2', …) of the same type, times scaleratio: yaxis: { scaleanchor: 'x' } keeps one unit the same length on both axes, e.g. for maps or square plots. Zooming either axis zooms the other. false or unset for none (the y axis of an image trace defaults to its anchor, for square pixels, as in Plotly); ignored with matches or when it would create a loop.

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

xaxis.scaleratio number ​

With scaleanchor: px per unit of this axis divided by px per unit of the anchor axis (2 makes one unit here twice as long).

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

xaxis.constrain enumerated ​

How a scaleanchor / matches constraint is met on this axis: range widens the range, domain shrinks the axis (and its subplot) inside its domain. Default domain on the axes of image traces (Plotly).

  • Type: enumerated
  • Values: "range" | "domain"
  • Default: "range"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.constraintoward enumerated ​

Which end stays put when a constraint changes the range or domain: left/center/right for x axes (default center), bottom/middle/top for y axes (default middle).

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

xaxis.layer enumerated ​

Draw the axis line, ticks and labels above or below the traces. Grid lines are always below.

  • Type: enumerated
  • Values: "above traces" | "below traces"
  • Default: "above traces"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

xaxis.automargin flaglist ​

Grow the figure margins so tick labels and the title fit (E4.2). true allows every direction; flags restrict it.

  • Type: flaglist
  • Flags: "height", "width", "left", "right", "top", "bottom" (combine with +)
  • Also accepts: true | false
  • Default: false
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.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: ticks
  • Animatable: no

xaxis.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: ticks
  • Animatable: no

xaxis.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: ticks
  • Animatable: no

xaxis.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: ticks
  • Animatable: no

xaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

xaxis.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: ticks
  • Animatable: no

xaxis.showticklabels boolean ​

Show tick labels.

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

xaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+ticks

xaxis.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+ticks (inherited)
  • Animatable: no

xaxis.tickfont.size number ​

Font size in CSS pixels.

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

xaxis.tickfont.color color ​

Text color.

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

xaxis.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+ticks (inherited)
  • Animatable: no

xaxis.tickfont.style enumerated ​

Font style.

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

xaxis.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+ticks (inherited)
  • Animatable: no

xaxis.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+ticks (inherited)
  • Animatable: no

xaxis.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+ticks (inherited)
  • Animatable: no

xaxis.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+ticks (inherited)
  • Animatable: no

xaxis.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: layout+ticks
  • Animatable: no

xaxis.autotickangles info_array ​

Candidate angles, in order of preference, for tickangle: auto.

  • Type: info_array [angle, …]
  • Default: [0, 30, 90]
  • Array OK: no
  • Edit type: layout+ticks
  • Animatable: no

xaxis.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: layout+ticks
  • Animatable: no

xaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: layout+ticks

xaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout+ticks (inherited)
  • Animatable: no

xaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout+ticks (inherited)
  • Animatable: no

xaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: layout+ticks (inherited)
  • Animatable: no

xaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

xaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

xaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

xaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

xaxis.tickprefix string ​

Text before each tick label.

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

xaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

xaxis.ticksuffix string ​

Text after each tick label.

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

xaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

xaxis.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: layout+ticks
  • Animatable: no

xaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

xaxis.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: layout+ticks
  • Animatable: no

xaxis.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: layout+ticks
  • Animatable: no

xaxis.ticklabelmode enumerated ​

Date axes: instant labels the tick instant; period centers each label in the period that starts at its tick (e.g. month names between month ticks).

  • Type: enumerated
  • Values: "instant" | "period"
  • Default: "instant"
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

xaxis.ticklabelposition enumerated ​

Tick labels outside or inside the plot area, optionally shifted to one side of the tick (top/bottom for y axes, left/right for x axes).

  • Type: enumerated
  • Values: "outside" | "inside" | "outside top" | "inside top" | "outside left" | "inside left" | "outside right" | "inside right" | "outside bottom" | "inside bottom"
  • Default: "outside"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.ticklabeloverflow enumerated ​

What to do with labels that overflow: keep them, or hide those past the figure or the axis domain. Defaults to hide past div for outside labels and hide past domain for inside labels.

  • Type: enumerated
  • Values: "allow" | "hide past div" | "hide past domain"
  • Default: none
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

xaxis.ticklabelstep integer ​

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

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

xaxis.minorloglabels enumerated ​

Log axes whose automatic ticks fall between powers of ten (2, 5 or every digit): small digits labels them with a small digit (2, 5), complete with the full value in the tick font, with tickprefix/ticksuffix (20, 50, 200), none leaves them unlabelled.

  • Type: enumerated
  • Values: "small digits" | "complete" | "none"
  • Default: "small digits"
  • Array OK: no
  • Edit type: layout+ticks
  • Animatable: no

xaxis.ticklabelshift integer ​

Shift of tick labels along the axis, in px.

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

xaxis.ticklabelstandoff integer ​

Extra distance between tick labels and ticks, in px.

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

xaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

xaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

xaxis.showdividers boolean ​

Multicategory axes: draw divider lines between groups.

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

xaxis.dividercolor color ​

Multicategory divider color. Defaults to color.

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

xaxis.dividerwidth number ​

Multicategory divider width in px.

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

xaxis.showline boolean ​

Draw the axis line.

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

xaxis.linecolor color ​

Axis line color. Defaults to color.

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

xaxis.linewidth number ​

Axis line width in px.

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

xaxis.mirror enumerated ​

Repeat the axis line on the opposite side of the plot area: true (line), ticks (line and ticks); all/allticks do the same on every subplot sharing this axis.

  • Type: enumerated
  • Values: true | "ticks" | false | "all" | "allticks"
  • Default: false
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

xaxis.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: layout+ticks+plot
  • Animatable: no

xaxis.ticklen number ​

Tick length in px.

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

xaxis.tickwidth number ​

Tick width in px.

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

xaxis.tickcolor color ​

Tick color. Defaults to color.

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

xaxis.showgrid boolean ​

Draw grid lines at each tick.

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

xaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

xaxis.gridwidth number ​

Grid line width in px.

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

xaxis.griddash string ​

Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

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

xaxis.zeroline boolean ​

Draw a line at 0 (linear axes whose range contains 0).

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

xaxis.zerolinecolor color ​

Zero line color. Defaults to color.

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

xaxis.zerolinewidth number ​

Zero line width in px.

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

xaxis.showspikes boolean ​

Draw a spike line from the hovered point to this axis. Defaults to false, or true when any other spike* attribute is set or hovermode is this axis' unified mode (x unified for x axes).

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

xaxis.spikecolor color ​

Spike line color. Defaults to the hovered point's color (or a contrasting color when that is too close to the background).

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

xaxis.spikethickness number ​

Spike line width in px (1.5 in unified hover).

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

xaxis.spikedash string ​

Spike line dash (dot in unified hover). Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

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

xaxis.spikemode flaglist ​

toaxis: from the point to the axis; across: across the whole plot area; marker: a dot on the axis. Combine with + (across+marker). Unified hover defaults to across.

  • Type: flaglist
  • Flags: "toaxis", "across", "marker" (combine with +)
  • Default: "toaxis"
  • Array OK: no
  • Edit type: none
  • Animatable: no

xaxis.spikesnap enumerated ​

hovered data: the spike follows the hovered point; data: the closest point within spikedistance, even when no label shows; cursor: the pointer position.

  • Type: enumerated
  • Values: "data" | "cursor" | "hovered data"
  • Default: "hovered data"
  • Array OK: no
  • Edit type: none
  • Animatable: no

xaxis.minor ​

Minor ticks and grid lines between the major ticks.

  • Type: object
  • Edit type: ticks

xaxis.minor.tickmode enumerated ​

As the major tickmode. Defaults to array when minor.tickvals is set, linear when minor.dtick is set, else auto.

  • Type: enumerated
  • Values: "auto" | "linear" | "array"
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.nticks integer ​

Maximum number of minor ticks per major interval for tickmode: auto (0 picks it from the axis length).

  • Type: integer ≥ 0
  • Default: 5
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.tick0 any ​

As the major tick0. Defaults to the major tick0.

  • Type: any
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.dtick any ​

Minor tick step. 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: ticks (inherited)
  • Animatable: no

xaxis.minor.tickvals data_array ​

Minor tick positions for tickmode: array.

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

xaxis.minor.ticks enumerated ​

Draw minor tick marks outside or inside the plot area, or not at all.

  • Type: enumerated
  • Values: "outside" | "inside" | ""
  • Default: ""
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.ticklen number ​

Minor tick length in px. Defaults to 60% of ticklen.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.tickwidth number ​

Minor tick width in px. Defaults to tickwidth.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.tickcolor color ​

Minor tick color. Defaults to tickcolor.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.showgrid boolean ​

Draw minor grid lines.

  • Type: boolean
  • Default: false
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.gridcolor color ​

Minor grid color. Defaults to gridcolor blended halfway to the plot background.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.gridwidth number ​

Minor grid width in px. Defaults to gridwidth.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.minor.griddash string ​

Minor grid dash style. Defaults to griddash. Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

  • Type: string
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

xaxis.title ​

Axis title.

  • Type: object
  • Edit type: layout+ticks+plot

xaxis.title.text string ​

Axis title text (supports rich-text tags, E2.10).

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

xaxis.title.font ​

Axis title font. Defaults to layout.font with 1.2× size.

  • Type: object
  • Edit type: layout+ticks+plot

xaxis.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+ticks+plot (inherited)
  • Animatable: no

xaxis.title.font.size number ​

Font size in CSS pixels.

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

xaxis.title.font.color color ​

Text color.

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

xaxis.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+ticks+plot (inherited)
  • Animatable: no

xaxis.title.font.style enumerated ​

Font style.

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

xaxis.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+ticks+plot (inherited)
  • Animatable: no

xaxis.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+ticks+plot (inherited)
  • Animatable: no

xaxis.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+ticks+plot (inherited)
  • Animatable: no

xaxis.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+ticks+plot (inherited)
  • Animatable: no

xaxis.title.standoff number ​

Distance in px between the tick labels and the title. By default it follows the tick labels automatically.

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

xaxis.rangeslider ​

Range slider (plan E5.9): an overview of all the data under the x axis, with a window over the range in view. Drag the window to pan, its ends to zoom, or click elsewhere to center the window there; the axis range changes with one relayout at the end of the drag. Y axes anchored to an axis with a range slider default to fixedrange: true, as in Plotly.

  • Type: object
  • Edit type: layout

xaxis.rangeslider.visible boolean ​

Show the range slider. Defaults to true when rangeslider is given (rangeslider: {} is enough) or the axis has an ohlc or candlestick trace, else false.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeslider.thickness number ​

Height of the slider as a fraction of the figure height minus margin.t and margin.b. The bottom margin grows to make room for it.

  • Type: number from 0 to 1
  • Default: 0.15
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeslider.bgcolor color ​

Background of the slider. Defaults to plot_bgcolor.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeslider.bordercolor color ​

Border color of the slider.

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

xaxis.rangeslider.borderwidth integer ​

Border width of the slider, px.

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

xaxis.rangeslider.autorange boolean ​

Span every data point of the axis (its autorange, whatever the axis range in view). Defaults to true unless a full range is given.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeslider.range info_array ​

Range the slider spans, in data units, like the axis range (dates on date axes, exponents on log axes). The slider always covers the axis range in view as well.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeslider.yaxis ​

Thumbnail y range per y axis: yaxis for the subplot on y, yaxis2 for y2, … (one thumbnail per subplot on this x axis, drawn over each other).

  • Type: object
  • Subplots: also yaxis2, yaxis3, … for subplot ids y2, y3, …
  • Edit type: layout (inherited)

xaxis.rangeslider.yaxis.rangemode enumerated ​

The y range of this subplot's thumbnail: match follows the y axis range in view, auto spans all the y data (autorange), fixed uses range. Defaults to fixed with a valid range, else match.

  • Type: enumerated
  • Values: "auto" | "fixed" | "match"
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeslider.yaxis.range info_array ​

Thumbnail y range for rangemode: 'fixed', in data units, like the axis range (dates on date axes, exponents on log axes).

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector ​

Range selector (plan E5.9): buttons over the chart that set the x range to a preset span ending at the current range end (last 6 months, year to date, all). Date axes only. The button whose range is in view shows as active.

  • Type: object
  • Edit type: layout

xaxis.rangeselector.visible boolean ​

Show the range selector. Defaults to true when it has buttons.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.buttons ​

The buttons, left to right.

  • Type: array of button objects; template defaults for every item go in buttondefaults
  • Edit type: layout (inherited)

xaxis.rangeselector.buttons[].visible boolean ​

Show this button.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.buttons[].step enumerated ​

Unit of the range the button sets, with count; all autoranges the axis instead.

  • Type: enumerated
  • Values: "month" | "year" | "day" | "hour" | "minute" | "second" | "all"
  • Default: "month"
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.buttons[].stepmode enumerated ​

backward: the range ends at the current range end and starts count steps before it. todate: it starts at the start of the step period, count - 1 periods back (count: 1, step: 'year' is year-to-date).

  • Type: enumerated
  • Values: "backward" | "todate"
  • Default: "backward"
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.buttons[].count number ​

Number of steps the range spans.

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

xaxis.rangeselector.buttons[].label string ​

Button text. Default: count and the first letter of step (6m), or all.

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

xaxis.rangeselector.buttons[].name string ​

Name of this button, used to reference it from a template via templateitemname.

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

xaxis.rangeselector.buttons[].templateitemname string ​

Name of a template button to inherit from. If no template item matches, this button is hidden (visible: false).

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

xaxis.rangeselector.x number ​

Horizontal position in paper coordinates (fractions of the plot area width). Defaults to the start of the axis domain. Give x and y together; one alone is ignored.

  • Type: number from -2 to 3
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.xanchor enumerated ​

Which side of the button row x refers to.

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

xaxis.rangeselector.y number ​

Vertical position in paper coordinates. Defaults to just above the highest subplot on this x axis.

  • Type: number from -2 to 3
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.yanchor enumerated ​

Which side of the button row y refers to.

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

xaxis.rangeselector.font ​

Button font. Defaults to layout.font.

  • Type: object
  • Edit type: layout

xaxis.rangeselector.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 (inherited)
  • Animatable: no

xaxis.rangeselector.font.size number ​

Font size in CSS pixels.

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

xaxis.rangeselector.font.color color ​

Text color.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.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 (inherited)
  • Animatable: no

xaxis.rangeselector.font.style enumerated ​

Font style.

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

xaxis.rangeselector.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 (inherited)
  • Animatable: no

xaxis.rangeselector.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 (inherited)
  • Animatable: no

xaxis.rangeselector.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 (inherited)
  • Animatable: no

xaxis.rangeselector.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 (inherited)
  • Animatable: no

xaxis.rangeselector.bgcolor color ​

Background of the buttons.

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

xaxis.rangeselector.activecolor color ​

Background of the active button (the one whose range is in view) and of hovered buttons. Defaults to bgcolor darkened (light colors) or lightened (dark colors).

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

xaxis.rangeselector.bordercolor color ​

Border color of the buttons.

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

xaxis.rangeselector.borderwidth number ​

Border width of the buttons, px.

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

yaxis ​

A y axis. yaxis2, yaxis3, … declare further y axes, referenced from traces as 'y2', 'y3', ….

  • Type: object
  • Subplots: also yaxis2, yaxis3, … for subplot ids y2, y3, …
  • Edit type: calc

yaxis.visible boolean ​

Draw the axis (line, ticks, labels, grid and title). A hidden axis still maps data to pixels.

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

yaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

yaxis.type enumerated ​

Axis type. '-' detects the type from the data of the first trace on this axis (Plotly's rules: mostly dates → date; more than twice as many distinct strings as numbers → category; two-level [[groups], [items]] arrays → multicategory; otherwise linear).

  • Type: enumerated
  • Values: "-" | "linear" | "log" | "date" | "category" | "multicategory"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

yaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

yaxis.autorange enumerated ​

Whether the range is computed from the data. reversed autoranges with the axis flipped. min/max autorange only that end and take the other from range (min reversed/max reversed also flip the axis). Defaults to false when a full range is given, to min/max when one end of range is null, and to reversed on a y axis only image traces use (row 0 at the top, as in Plotly).

  • Type: enumerated
  • Values: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max"
  • Default: true
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.autorangeoptions ​

Constraints applied to the computed autorange.

  • Type: object
  • Edit type: layout+ticks+plot

yaxis.autorangeoptions.minallowed any ​

The autoranged minimum is exactly this value (data units).

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

yaxis.autorangeoptions.maxallowed any ​

The autoranged maximum is exactly this value (data units).

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

yaxis.autorangeoptions.clipmin any ​

The autoranged minimum is at least this value (data units).

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

yaxis.autorangeoptions.clipmax any ​

The autoranged maximum is at most this value (data units).

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

yaxis.autorangeoptions.include any ​

Value(s) the autorange must include (data units).

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

yaxis.rangemode enumerated ​

Linear axes only. tozero extends the autorange to include 0; nonnegative keeps it ≥ 0.

  • Type: enumerated
  • Values: "normal" | "tozero" | "nonnegative"
  • Default: "normal"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.fixedrange boolean ​

Disables zoom and pan on this axis (drag, scroll, and modebar zoom leave its range alone).

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

yaxis.range info_array ​

Visible range [start, end] in data units (numbers, dates or category names; exponents on log axes, as in Plotly). Setting it turns autorange off; null for one end autoranges that end only.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: ticks+plot
  • Animatable: yes

yaxis.minallowed any ​

Lowest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

yaxis.maxallowed any ​

Highest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

yaxis.rangebreaks ​

Spans hidden from the axis (plan E3.8): the axis skips them, so a weekday-only stock chart has no gaps for weekends or nights. Date and linear axes; data inside a break is not drawn. Ticks never land in a break; hover, zoom and pan work across breaks.

  • Type: array of rangebreak objects; template defaults for every item go in rangebreakdefaults
  • Edit type: calc

yaxis.rangebreaks[].enabled boolean ​

Whether this range break is applied.

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

yaxis.rangebreaks[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template break; hidden breaks are ignored like disabled ones.

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

yaxis.rangebreaks[].bounds info_array ​

Lower and upper bound of the break. Without pattern: values in data units (['2024-01-06', '2024-01-08']). With pattern: 'day of week': day numbers 0–6 (Sunday = 0) or English day names (['sat', 'mon'] hides Saturday and Sunday). With pattern: 'hour': hours 0–24 ([17, 9] hides 17:00–09:00, wrapping past midnight). Patterns use UTC days and hours.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

yaxis.rangebreaks[].pattern enumerated ​

How bounds repeat: day of week or hour (date axes only), or '' for a single span. Defaults to day of week when bounds names days, else ''.

  • Type: enumerated
  • Values: "day of week" | "hour" | ""
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

yaxis.rangebreaks[].values info_array ​

Individual values to hide when no bounds are given, each hiding [value, value + dvalue) (e.g. holidays on a date axis).

  • Type: info_array [any, …], any length
  • Default: none
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

yaxis.rangebreaks[].dvalue number ​

Size of each break in values, in data units (milliseconds on date axes). Default: one day.

  • Type: number ≥ 0
  • Default: 86400000
  • Array OK: no
  • Edit type: calc (inherited)
  • Animatable: no

yaxis.rangebreaks[].name string ​

Name of this rangebreak, used to reference it from a template via templateitemname.

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

yaxis.rangebreaks[].templateitemname string ​

Name of a template rangebreak to inherit from. If no template item matches, this rangebreak is hidden (visible: false).

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

yaxis.domain info_array ​

Fraction of the plot area [start, end] this axis spans.

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

yaxis.anchor subplotid ​

The x axis this axis is drawn against, or free. Defaults to the x axis of the first subplot using this axis.

  • Type: subplotid (x, x2, x3, …)
  • Also accepts: "free"
  • Default: "x"
  • Array OK: no
  • Edit type: layout
  • Animatable: no

yaxis.side enumerated ​

Which side of the plot area the axis is drawn on.

  • Type: enumerated
  • Values: "left" | "right"
  • Default: "left"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.overlaying subplotid ​

Draw this axis over another y axis ('y', 'y2', …), sharing its domain (this axis' own domain is ignored), e.g. a secondary y axis with side: 'right'. Unset (or free) by default. The target must exist and must not overlay another axis itself; otherwise this is ignored. Templates cannot set it, since it names specific axes.

  • Type: subplotid (y, y2, y3, …)
  • Also accepts: "free"
  • Default: "y"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.position number ​

Position of the axis in paper coordinates (0–1 across the x direction). Only used when anchor is free.

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

yaxis.autoshift boolean ​

y axes with anchor: 'free' only: move the axis sideways so it does not overlap other free axes on the same side (and default position to the overlaid plot's edge, automargin to true, shift to ∓3 px). Plotly semantics.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.shift number ​

y axes with anchor: 'free' only: extra horizontal offset in px (negative to the left). Defaults to -3 on the left and 3 on the right when autoshift is on, else 0.

  • Type: number
  • Default: none
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.matches string ​

Link this axis' range to another axis of the same type ('x', 'x2', 'y', …): they autorange together over all their data, and zoom, pan and relayout of one move all. The linked axes share range, autorange, rangemode, rangebreaks, constrain and the category order. An axis that would create a loop, or a target of another type, is ignored.

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

yaxis.scaleanchor any ​

Lock the scale (px per unit) of this axis to another axis ('x', 'y2', …) of the same type, times scaleratio: yaxis: { scaleanchor: 'x' } keeps one unit the same length on both axes, e.g. for maps or square plots. Zooming either axis zooms the other. false or unset for none (the y axis of an image trace defaults to its anchor, for square pixels, as in Plotly); ignored with matches or when it would create a loop.

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

yaxis.scaleratio number ​

With scaleanchor: px per unit of this axis divided by px per unit of the anchor axis (2 makes one unit here twice as long).

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

yaxis.constrain enumerated ​

How a scaleanchor / matches constraint is met on this axis: range widens the range, domain shrinks the axis (and its subplot) inside its domain. Default domain on the axes of image traces (Plotly).

  • Type: enumerated
  • Values: "range" | "domain"
  • Default: "range"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.constraintoward enumerated ​

Which end stays put when a constraint changes the range or domain: left/center/right for x axes (default center), bottom/middle/top for y axes (default middle).

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

yaxis.layer enumerated ​

Draw the axis line, ticks and labels above or below the traces. Grid lines are always below.

  • Type: enumerated
  • Values: "above traces" | "below traces"
  • Default: "above traces"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

yaxis.automargin flaglist ​

Grow the figure margins so tick labels and the title fit (E4.2). true allows every direction; flags restrict it.

  • Type: flaglist
  • Flags: "height", "width", "left", "right", "top", "bottom" (combine with +)
  • Also accepts: true | false
  • Default: false
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.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: ticks
  • Animatable: no

yaxis.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: ticks
  • Animatable: no

yaxis.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: ticks
  • Animatable: no

yaxis.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: ticks
  • Animatable: no

yaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

yaxis.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: ticks
  • Animatable: no

yaxis.showticklabels boolean ​

Show tick labels.

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

yaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+ticks

yaxis.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+ticks (inherited)
  • Animatable: no

yaxis.tickfont.size number ​

Font size in CSS pixels.

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

yaxis.tickfont.color color ​

Text color.

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

yaxis.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+ticks (inherited)
  • Animatable: no

yaxis.tickfont.style enumerated ​

Font style.

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

yaxis.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+ticks (inherited)
  • Animatable: no

yaxis.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+ticks (inherited)
  • Animatable: no

yaxis.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+ticks (inherited)
  • Animatable: no

yaxis.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+ticks (inherited)
  • Animatable: no

yaxis.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: layout+ticks
  • Animatable: no

yaxis.autotickangles info_array ​

Candidate angles, in order of preference, for tickangle: auto.

  • Type: info_array [angle, …]
  • Default: [0, 30, 90]
  • Array OK: no
  • Edit type: layout+ticks
  • Animatable: no

yaxis.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: layout+ticks
  • Animatable: no

yaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: layout+ticks

yaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout+ticks (inherited)
  • Animatable: no

yaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout+ticks (inherited)
  • Animatable: no

yaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: layout+ticks (inherited)
  • Animatable: no

yaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

yaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

yaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

yaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

yaxis.tickprefix string ​

Text before each tick label.

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

yaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

yaxis.ticksuffix string ​

Text after each tick label.

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

yaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

yaxis.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: layout+ticks
  • Animatable: no

yaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

yaxis.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: layout+ticks
  • Animatable: no

yaxis.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: layout+ticks
  • Animatable: no

yaxis.ticklabelmode enumerated ​

Date axes: instant labels the tick instant; period centers each label in the period that starts at its tick (e.g. month names between month ticks).

  • Type: enumerated
  • Values: "instant" | "period"
  • Default: "instant"
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

yaxis.ticklabelposition enumerated ​

Tick labels outside or inside the plot area, optionally shifted to one side of the tick (top/bottom for y axes, left/right for x axes).

  • Type: enumerated
  • Values: "outside" | "inside" | "outside top" | "inside top" | "outside left" | "inside left" | "outside right" | "inside right" | "outside bottom" | "inside bottom"
  • Default: "outside"
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.ticklabeloverflow enumerated ​

What to do with labels that overflow: keep them, or hide those past the figure or the axis domain. Defaults to hide past div for outside labels and hide past domain for inside labels.

  • Type: enumerated
  • Values: "allow" | "hide past div" | "hide past domain"
  • Default: none
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

yaxis.ticklabelstep integer ​

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

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

yaxis.minorloglabels enumerated ​

Log axes whose automatic ticks fall between powers of ten (2, 5 or every digit): small digits labels them with a small digit (2, 5), complete with the full value in the tick font, with tickprefix/ticksuffix (20, 50, 200), none leaves them unlabelled.

  • Type: enumerated
  • Values: "small digits" | "complete" | "none"
  • Default: "small digits"
  • Array OK: no
  • Edit type: layout+ticks
  • Animatable: no

yaxis.ticklabelshift integer ​

Shift of tick labels along the axis, in px.

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

yaxis.ticklabelstandoff integer ​

Extra distance between tick labels and ticks, in px.

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

yaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

yaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

yaxis.showdividers boolean ​

Multicategory axes: draw divider lines between groups.

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

yaxis.dividercolor color ​

Multicategory divider color. Defaults to color.

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

yaxis.dividerwidth number ​

Multicategory divider width in px.

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

yaxis.showline boolean ​

Draw the axis line.

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

yaxis.linecolor color ​

Axis line color. Defaults to color.

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

yaxis.linewidth number ​

Axis line width in px.

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

yaxis.mirror enumerated ​

Repeat the axis line on the opposite side of the plot area: true (line), ticks (line and ticks); all/allticks do the same on every subplot sharing this axis.

  • Type: enumerated
  • Values: true | "ticks" | false | "all" | "allticks"
  • Default: false
  • Array OK: no
  • Edit type: layout+ticks+plot
  • Animatable: no

yaxis.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: layout+ticks+plot
  • Animatable: no

yaxis.ticklen number ​

Tick length in px.

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

yaxis.tickwidth number ​

Tick width in px.

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

yaxis.tickcolor color ​

Tick color. Defaults to color.

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

yaxis.showgrid boolean ​

Draw grid lines at each tick.

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

yaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: ticks
  • Animatable: no

yaxis.gridwidth number ​

Grid line width in px.

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

yaxis.griddash string ​

Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

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

yaxis.zeroline boolean ​

Draw a line at 0 (linear axes whose range contains 0).

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

yaxis.zerolinecolor color ​

Zero line color. Defaults to color.

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

yaxis.zerolinewidth number ​

Zero line width in px.

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

yaxis.showspikes boolean ​

Draw a spike line from the hovered point to this axis. Defaults to false, or true when any other spike* attribute is set or hovermode is this axis' unified mode (x unified for x axes).

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

yaxis.spikecolor color ​

Spike line color. Defaults to the hovered point's color (or a contrasting color when that is too close to the background).

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

yaxis.spikethickness number ​

Spike line width in px (1.5 in unified hover).

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

yaxis.spikedash string ​

Spike line dash (dot in unified hover). Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

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

yaxis.spikemode flaglist ​

toaxis: from the point to the axis; across: across the whole plot area; marker: a dot on the axis. Combine with + (across+marker). Unified hover defaults to across.

  • Type: flaglist
  • Flags: "toaxis", "across", "marker" (combine with +)
  • Default: "toaxis"
  • Array OK: no
  • Edit type: none
  • Animatable: no

yaxis.spikesnap enumerated ​

hovered data: the spike follows the hovered point; data: the closest point within spikedistance, even when no label shows; cursor: the pointer position.

  • Type: enumerated
  • Values: "data" | "cursor" | "hovered data"
  • Default: "hovered data"
  • Array OK: no
  • Edit type: none
  • Animatable: no

yaxis.minor ​

Minor ticks and grid lines between the major ticks.

  • Type: object
  • Edit type: ticks

yaxis.minor.tickmode enumerated ​

As the major tickmode. Defaults to array when minor.tickvals is set, linear when minor.dtick is set, else auto.

  • Type: enumerated
  • Values: "auto" | "linear" | "array"
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.nticks integer ​

Maximum number of minor ticks per major interval for tickmode: auto (0 picks it from the axis length).

  • Type: integer ≥ 0
  • Default: 5
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.tick0 any ​

As the major tick0. Defaults to the major tick0.

  • Type: any
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.dtick any ​

Minor tick step. 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: ticks (inherited)
  • Animatable: no

yaxis.minor.tickvals data_array ​

Minor tick positions for tickmode: array.

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

yaxis.minor.ticks enumerated ​

Draw minor tick marks outside or inside the plot area, or not at all.

  • Type: enumerated
  • Values: "outside" | "inside" | ""
  • Default: ""
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.ticklen number ​

Minor tick length in px. Defaults to 60% of ticklen.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.tickwidth number ​

Minor tick width in px. Defaults to tickwidth.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.tickcolor color ​

Minor tick color. Defaults to tickcolor.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.showgrid boolean ​

Draw minor grid lines.

  • Type: boolean
  • Default: false
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.gridcolor color ​

Minor grid color. Defaults to gridcolor blended halfway to the plot background.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.gridwidth number ​

Minor grid width in px. Defaults to gridwidth.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.minor.griddash string ​

Minor grid dash style. Defaults to griddash. Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

  • Type: string
  • Default: none
  • Array OK: no
  • Edit type: ticks (inherited)
  • Animatable: no

yaxis.title ​

Axis title.

  • Type: object
  • Edit type: layout+ticks+plot

yaxis.title.text string ​

Axis title text (supports rich-text tags, E2.10).

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

yaxis.title.font ​

Axis title font. Defaults to layout.font with 1.2× size.

  • Type: object
  • Edit type: layout+ticks+plot

yaxis.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+ticks+plot (inherited)
  • Animatable: no

yaxis.title.font.size number ​

Font size in CSS pixels.

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

yaxis.title.font.color color ​

Text color.

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

yaxis.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+ticks+plot (inherited)
  • Animatable: no

yaxis.title.font.style enumerated ​

Font style.

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

yaxis.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+ticks+plot (inherited)
  • Animatable: no

yaxis.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+ticks+plot (inherited)
  • Animatable: no

yaxis.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+ticks+plot (inherited)
  • Animatable: no

yaxis.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+ticks+plot (inherited)
  • Animatable: no

yaxis.title.standoff number ​

Distance in px between the tick labels and the title. By default it follows the tick labels automatically.

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

selections ​

Selections as layout objects (plan E5.12): each box or lasso drag in select / lasso mode adds one (shift keeps the others), and every selection on a subplot selects the points inside it (selectedpoints follows). Set them to restore a selection; drag one to move or resize it; a double-click clears them.

  • Type: array of selection objects; template defaults for every item go in selectiondefaults
  • Edit type: plot

selections[].visible boolean ​

Whether this selection applies (set to false by the template machinery when templateitemname names no template selection).

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

selections[].type enumerated ​

rect: the box from (x0, y0) to (x1, y1); path: the polygon path (lasso). Default: path when path is set, else rect.

  • Type: enumerated
  • Values: "rect" | "path"
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

selections[].xref subplotid ​

The x axis the coordinates refer to (x, x2, …).

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

selections[].yref subplotid ​

The y axis the coordinates refer to (y, y2, …).

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

selections[].x0 any ​

Start x of a rect, in data units of xref (dates, category names or indices; data values on log axes). A rect needs all four of x0, x1, y0, y1.

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

selections[].x1 any ​

End x of a rect.

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

selections[].y0 any ​

Start y of a rect.

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

selections[].y1 any ​

End y of a rect.

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

selections[].path string ​

Polygon of a path selection, SVG-like in data units: M x,y L x,y … Z (also H, V and relative commands). Dates use _ between date and time (2024-01-05_12:00).

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

selections[].opacity number ​

Opacity of the outline.

  • Type: number from 0 to 1
  • Default: 0.7
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

selections[].line ​

Outline style.

  • Type: object
  • Edit type: plot (inherited)

selections[].line.color color ​

Outline color. Default: a color contrasting with plot_bgcolor (white on dark, #444 on light).

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

selections[].line.width number ​

Outline width, px.

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

selections[].line.dash string ​

Dash style: solid, dot, dash, longdash, dashdot, longdashdot or a px list ('5px,10px').

  • Type: string
  • Default: "dot"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

selections[].name string ​

Name of this selection, used to reference it from a template via templateitemname.

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

selections[].templateitemname string ​

Name of a template selection to inherit from. If no template item matches, this selection is hidden (visible: false).

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

colorscale ​

The automatic colorscales (autocolorscale), usually set by a template.

  • Type: object
  • Edit type: style

colorscale.sequential colorscale ​

Colorscale for non-negative color domains when autocolorscale is on (Plotly default Reds).

  • Type: colorscale
  • Default: "Reds"
  • Array OK: no
  • Edit type: style
  • Animatable: no

colorscale.sequentialminus colorscale ​

Colorscale for non-positive color domains when autocolorscale is on (Plotly default Blues).

  • Type: colorscale
  • Default: "Blues"
  • Array OK: no
  • Edit type: style
  • Animatable: no

colorscale.diverging colorscale ​

Colorscale for color domains that cross 0 when autocolorscale is on (Plotly default RdBu).

  • Type: colorscale
  • Default: "RdBu"
  • Array OK: no
  • Edit type: style
  • Animatable: no

colorscaleInterpolation enumerated ​

Color space in which colorscale stops are interpolated: rgb (sRGB, as Plotly), oklab (perceptually uniform), lab (CIE Lab*) or hcl (CIE LCh, hue along the shorter arc).

  • Type: enumerated
  • Values: "rgb" | "oklab" | "lab" | "hcl"
  • Default: "rgb"
  • Array OK: no
  • Edit type: style
  • Animatable: no

coloraxis ​

A colorscale and domain shared by every trace container with coloraxis: 'coloraxis' (or coloraxis2, …).

  • Type: object
  • Subplots: also coloraxis2, coloraxis3, … for subplot ids coloraxis2, coloraxis3, …
  • Edit type: style

coloraxis.colorscale colorscale ​

Colorscale for numeric color arrays of the traces that reference this axis 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

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

coloraxis.reversescale boolean ​

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

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

coloraxis.cauto boolean ​

Compute the color domain from the numeric color arrays of the traces that reference this axis values. Defaults to false when both cmin and cmax are given.

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

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

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

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

coloraxis.showscale boolean ​

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

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

coloraxis.colorbar ​

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

  • Type: object
  • Edit type: colorbars+layout

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

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

coloraxis.colorbar.thickness number ​

Thickness of the color bar.

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

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

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

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

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

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

coloraxis.colorbar.xpad number ​

Horizontal padding, px.

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

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

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

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

coloraxis.colorbar.ypad number ​

Vertical padding, px.

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

coloraxis.colorbar.outlinecolor color ​

Color of the outline around the bar.

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

coloraxis.colorbar.outlinewidth number ​

Outline width, px.

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

coloraxis.colorbar.bordercolor color ​

Border color of the colorbar box.

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

coloraxis.colorbar.borderwidth number ​

Border width of the box, px.

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

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

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

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

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

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

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

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

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

coloraxis.colorbar.ticklen number ​

Tick length in px.

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

coloraxis.colorbar.tickwidth number ​

Tick width in px.

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

coloraxis.colorbar.tickcolor color ​

Tick color. Defaults to color.

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

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

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

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

coloraxis.colorbar.showticklabels boolean ​

Show tick labels.

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

coloraxis.colorbar.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

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

coloraxis.colorbar.tickfont.size number ​

Font size in CSS pixels.

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

coloraxis.colorbar.tickfont.color color ​

Text color.

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

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

coloraxis.colorbar.tickfont.style enumerated ​

Font style.

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

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

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

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

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

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

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

coloraxis.colorbar.tickprefix string ​

Text before each tick label.

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

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

coloraxis.colorbar.ticksuffix string ​

Text after each tick label.

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

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

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

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

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

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

coloraxis.colorbar.title ​

Colorbar title.

  • Type: object
  • Edit type: colorbars+layout

coloraxis.colorbar.title.text string ​

Colorbar title.

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

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

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

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

coloraxis.colorbar.title.font.color color ​

Text color.

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

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

coloraxis.colorbar.title.font.style enumerated ​

Font style.

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

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

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

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

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

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

barmode enumerated ​

How bars at the same position combine: side by side (group), stacked (stack), stacked with negative values below zero (relative), or drawn over each other (overlay).

  • Type: enumerated
  • Values: "group" | "stack" | "relative" | "overlay"
  • Default: "group"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

barnorm enumerated ​

Normalize each position's total to 1 (fraction) or 100 (percent).

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

bargap number ​

Gap between bars at neighboring positions, as a fraction of the position slot.

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

bargroupgap number ​

Gap between bars of the same position, as a fraction of each bar’s share.

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

barcornerradius any ​

Default marker.cornerradius of bars: CSS px, or a percentage of the bar width ('30%').

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

hiddenlabels data_array ​

Labels of pie slices to hide (like visible: 'legendonly' for traces), across all pies. Legend clicks on pie items toggle it.

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

piecolorway colorlist ​

Default slice colors. Defaults to layout.colorway; extended with lighter and darker copies when extendpiecolors is on.

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

extendpiecolors boolean ​

Extend the slice colorway to three times its length: every color 20% lighter, then every color 20% darker. Colors from marker.colors are never extended.

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

boxmode enumerated ​

How boxes of different traces at the same position combine: side by side (group) or drawn over each other (overlay).

  • Type: enumerated
  • Values: "group" | "overlay"
  • Default: "overlay"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

boxgap number ​

Gap between boxes at neighboring positions, as a fraction of the position slot.

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

boxgroupgap number ​

Gap between the boxes of one position in group mode, as a fraction of each one's share.

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

funnelmode enumerated ​

How funnel bars at the same position combine: side by side (group), stacked on top of one another (stack), or drawn over each other (overlay; lower the opacity to see them all). Traces of other types never share their slots.

  • Type: enumerated
  • Values: "stack" | "group" | "overlay"
  • Default: "stack"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

funnelgap number ​

Gap between funnel bars at neighboring positions, as a fraction of the position slot.

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

funnelgroupgap number ​

Gap between funnel bars of the same position, as a fraction of each bar’s share.

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

funnelareacolorway colorlist ​

Default stage colors. Defaults to layout.colorway; extended with lighter and darker copies when extendfunnelareacolors is on.

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

extendfunnelareacolors boolean ​

Extend the stage colorway to three times its length: every color 20% lighter, then every color 20% darker. Colors from marker.colors are never extended.

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

waterfallmode enumerated ​

How waterfall bars at the same position combine: side by side (group) or drawn over each other (overlay; lower the opacity to see them all). Traces of other types never share their slots.

  • Type: enumerated
  • Values: "group" | "overlay"
  • Default: "group"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

waterfallgap number ​

Gap between waterfall bars at neighboring positions, as a fraction of the position slot.

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

waterfallgroupgap number ​

Gap between waterfall bars of the same position, as a fraction of each bar’s share.

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

geo ​

A map-projection subplot. geo2, geo3, … declare more, referenced from geo traces' geo ('geo2').

  • Type: object
  • Subplots: also geo2, geo3, … for subplot ids geo2, geo3, …
  • Edit type: plot

geo.domain ​

Extent of the geo subplot as fractions of the plot area, or the layout.grid cell at row / column. A map keeps its shape, so at projection.scale 1 it fills the width or the height of its domain, rarely both. Subplots without a domain are stacked from the bottom.

  • Type: object
  • Edit type: plot

geo.domain.x info_array ​

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

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

geo.domain.y info_array ​

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

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

geo.domain.row integer ​

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

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

geo.domain.column integer ​

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

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

geo.fitbounds enumerated ​

Fit the view to the data of the subplot's traces: locations to the points and locations they show, geojson to the whole of their geojson, false to leave the view as set. The fit sets center and projection.scale; on a world map also projection.rotation.lon, and with a clipped projection (orthographic, …) projection.rotation.lat and both axis ranges. It is off when the figure sets any of the attributes it would set, and for the projections it cannot fit (albers usa, craig, peirce quincuncial, satellite).

  • Type: enumerated
  • Values: false | "locations" | "geojson"
  • Default: "locations"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.resolution enumerated ​

Detail of the base layers, as the scale denominator of the map data in millions: 110 (1:110,000,000, coarse) or 50 (1:50,000,000).

  • Type: enumerated
  • Values: 110 | 50
  • Default: 110
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.scope enumerated ​

The part of the world the base layers cover. A scope other than world also sets the default projection, ranges and rotation. albers usa maps are always usa.

  • Type: enumerated
  • Values: "africa" | "antarctica" | "asia" | "europe" | "north america" | "oceania" | "south america" | "usa" | "world"
  • Default: "world"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.projection ​

How the globe is projected onto the subplot.

  • Type: object
  • Edit type: plot

geo.projection.type enumerated ​

The map projection. Defaults to the scope's: equirectangular for the world, albers usa for usa, a conic or Mercator projection for the continents. The values are Plotly's, and globe3d, a Holochart extra: a 3D globe with the view of orthographic.

  • Type: enumerated
  • Values: "airy" | "aitoff" | "albers" | "albers usa" | "august" | "azimuthal equal area" | "azimuthal equidistant" | "baker" | "bertin1953" | "boggs" | "bonne" | "bottomley" | "bromley" | "collignon" | "conic conformal" | "conic equal area" | "conic equidistant" | "craig" | "craster" | "cylindrical equal area" | "cylindrical stereographic" | "eckert1" | "eckert2" | "eckert3" | "eckert4" | "eckert5" | "eckert6" | "eisenlohr" | "equal earth" | "equirectangular" | "fahey" | "foucaut" | "foucaut sinusoidal" | "ginzburg4" | "ginzburg5" | "ginzburg6" | "ginzburg8" | "ginzburg9" | "globe3d" | "gnomonic" | "gringorten" | "gringorten quincuncial" | "guyou" | "hammer" | "hill" | "homolosine" | "hufnagel" | "hyperelliptical" | "kavrayskiy7" | "lagrange" | "larrivee" | "laskowski" | "loximuthal" | "mercator" | "miller" | "mollweide" | "mt flat polar parabolic" | "mt flat polar quartic" | "mt flat polar sinusoidal" | "natural earth" | "natural earth1" | "natural earth2" | "nell hammer" | "nicolosi" | "orthographic" | "patterson" | "peirce quincuncial" | "polyconic" | "rectangular polyconic" | "robinson" | "satellite" | "sinu mollweide" | "sinusoidal" | "stereographic" | "times" | "transverse mercator" | "van der grinten" | "van der grinten2" | "van der grinten3" | "van der grinten4" | "wagner4" | "wagner6" | "wiechel" | "winkel tripel" | "winkel3"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.projection.rotation ​

Rotation of the globe before it is projected. albers usa has none.

  • Type: object
  • Edit type: plot

geo.projection.rotation.lon number ​

Longitude at the center of the projection, in degrees east: turns the globe about its axis. Defaults to the middle of lonaxis.range.

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

geo.projection.rotation.lat number ​

Latitude at the center of the projection, in degrees north: tips the globe towards the viewer.

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

geo.projection.rotation.roll number ​

Turn of the map about the line of sight, in degrees (180 draws it upside down).

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

geo.projection.tilt number ​

satellite only: tilt of the view away from straight down, in degrees.

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

geo.projection.distance number ​

satellite only: distance of the viewpoint from the globe's center, in globe radii (above 1: outside the surface).

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

geo.projection.parallels info_array ​

Conic projections only: the two standard parallels, in degrees, where the cone meets the globe. Defaults to the scope's, or [0, 60].

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

geo.projection.scale number ​

Zoom factor. At 1 the lonaxis / lataxis ranges are fitted into the domain.

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

geo.projection.minscale number ​

Lower limit of zooming by hand, as a projection.scale value (0.5: out to half the fitted size). 0 sets no limit.

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

geo.projection.maxscale number ​

Upper limit of zooming by hand, as a projection.scale value (2: in to twice the fitted size). Unset sets no limit.

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

geo.center ​

The point of the map at the middle of the subplot (panning moves it).

  • Type: object
  • Edit type: plot

geo.center.lon number ​

Longitude at the middle of the subplot, in degrees. Defaults to the middle of lonaxis.range on a scoped map and to projection.rotation.lon on a world map.

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

geo.center.lat number ​

Latitude at the middle of the subplot, in degrees. Defaults to the middle of lataxis.range.

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

geo.visible boolean ​

Default of the base layers and the graticule: false hides all of them (also those a template shows) unless the figure shows one itself.

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

geo.showcoastlines boolean ​

Draw the coastlines. On by default on world maps.

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

geo.coastlinecolor color ​

Color of the coastlines.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.coastlinewidth number ​

Line width of the coastlines, px.

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

geo.showland boolean ​

Fill the land.

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

geo.landcolor color ​

Fill color of the land.

  • Type: color
  • Default: "#F0DC82"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.showocean boolean ​

Fill the oceans.

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

geo.oceancolor color ​

Fill color of the oceans.

  • Type: color
  • Default: "#3399FF"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.showlakes boolean ​

Fill the lakes.

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

geo.lakecolor color ​

Fill color of the lakes.

  • Type: color
  • Default: "#3399FF"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.showrivers boolean ​

Draw the rivers.

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

geo.rivercolor color ​

Color of the rivers.

  • Type: color
  • Default: "#3399FF"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.riverwidth number ​

Line width of the rivers, px.

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

geo.showcountries boolean ​

Draw the borders between countries. On by default on scoped maps other than usa.

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

geo.countrycolor color ​

Color of the country borders.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.countrywidth number ​

Line width of the country borders, px.

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

geo.showsubunits boolean ​

Draw the borders inside countries (states, provinces). The map data has them for usa, and for north america at resolution 50; on by default there, never drawn elsewhere.

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

geo.subunitcolor color ​

Color of the subunit borders.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.subunitwidth number ​

Line width of the subunit borders, px.

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

geo.showframe boolean ​

Draw the outline of the projected globe. World maps only, where it is on by default.

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

geo.framecolor color ​

Color of the frame.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.framewidth number ​

Line width of the frame, px.

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

geo.bgcolor color ​

Background color of the map, inside its frame.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.lonaxis ​

The longitude axis of a geo subplot: its range and its graticule lines.

  • Type: object
  • Edit type: plot

geo.lonaxis.range info_array ​

The longitudes in view, [start, end] in degrees: the map is fitted to this range and clipped to it. Defaults to the scope's range, or to the widest span the projection can show around projection.rotation.lon.

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

geo.lonaxis.showgrid boolean ​

Draw the meridians of the graticule.

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

geo.lonaxis.tick0 number ​

A longitude one of the meridians passes through, in degrees.

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

geo.lonaxis.dtick number ​

Step between the meridians, in degrees. Defaults to 30.

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

geo.lonaxis.gridcolor color ​

Color of the meridians.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.lonaxis.gridwidth number ​

Line width of the meridians, px.

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

geo.lonaxis.griddash string ​

Dash style of the meridians: solid, dot, dash, longdash, dashdot, longdashdot, or a list of dash lengths in px (5px,10px).

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

geo.lataxis ​

The latitude axis of a geo subplot: its range and its graticule lines.

  • Type: object
  • Edit type: plot

geo.lataxis.range info_array ​

The latitudes in view, [start, end] in degrees: the map is fitted to this range and clipped to it. Defaults to the scope's range, or to the widest span the projection can show around projection.rotation.lat.

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

geo.lataxis.showgrid boolean ​

Draw the parallels of the graticule.

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

geo.lataxis.tick0 number ​

A latitude one of the parallels passes through, in degrees.

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

geo.lataxis.dtick number ​

Step between the parallels, in degrees. Defaults to 10.

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

geo.lataxis.gridcolor color ​

Color of the parallels.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

geo.lataxis.gridwidth number ​

Line width of the parallels, px.

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

geo.lataxis.griddash string ​

Dash style of the parallels: solid, dot, dash, longdash, dashdot, longdashdot, or a list of dash lengths in px (5px,10px).

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

geo.uirevision any ​

Persistence of user-driven changes of the view (rotation, center and scale). Defaults to layout.uirevision.

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

iciclecolorway colorlist ​

Default colors of the first-level icicle nodes (deeper nodes take their parent's). Defaults to layout.colorway; extended with lighter and darker copies when extendiciclecolors is on.

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

extendiciclecolors boolean ​

Extend iciclecolorway to three times its length: every color 20% lighter, then every color 20% darker. Colors from marker.colors are never extended.

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

sunburstcolorway colorlist ​

Default colors of the first-level sunburst nodes (deeper nodes take their parent's). Defaults to layout.colorway; extended with lighter and darker copies when extendsunburstcolors is on.

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

extendsunburstcolors boolean ​

Extend sunburstcolorway to three times its length: every color 20% lighter, then every color 20% darker. Colors from marker.colors are never extended.

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

treemapcolorway colorlist ​

Default colors of the first-level treemap nodes (deeper nodes take their parent's). Defaults to layout.colorway; extended with lighter and darker copies when extendtreemapcolors is on.

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

extendtreemapcolors boolean ​

Extend treemapcolorway to three times its length: every color 20% lighter, then every color 20% darker. Colors from marker.colors are never extended.

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

polar ​

A polar subplot. polar2, polar3, … declare more, referenced from polar traces' subplot ('polar2').

  • Type: object
  • Subplots: also polar2, polar3, … for subplot ids polar2, polar3, …
  • Edit type: calc

polar.domain ​

Extent of the polar subplot as fractions of the plot area, or the layout.grid cell at row / column. The subplot is the largest circle (or sector) that fits in it, centered.

  • Type: object
  • Edit type: plot

polar.domain.x info_array ​

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

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

polar.domain.y info_array ​

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

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

polar.domain.row integer ​

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

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

polar.domain.column integer ​

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

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

polar.sector info_array ​

Angular span [start, end] of the subplot in degrees, counterclockwise from 3 o’clock ([0, 180]: the upper half).

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

polar.hole number ​

Fraction of the radius cut out of the middle.

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

polar.bgcolor color ​

Background color of the subplot.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.gridshape enumerated ​

Radial grid lines and the angular axis line as circles (circular) or polygons through the category angles (linear: radar charts). Category angular axes only.

  • Type: enumerated
  • Values: "circular" | "linear"
  • Default: "circular"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis ​

The radial axis of a polar subplot.

  • Type: object
  • Edit type: calc

polar.radialaxis.visible boolean ​

Draw the axis (line, ticks, labels and grid).

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

polar.radialaxis.showline boolean ​

Draw the axis line.

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

polar.radialaxis.showgrid boolean ​

Draw the grid lines.

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

polar.radialaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.linecolor color ​

Axis line color. Defaults to color.

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

polar.radialaxis.linewidth number ​

Axis line width in px.

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

polar.radialaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.gridwidth number ​

Grid line width in px.

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

polar.radialaxis.griddash string ​

Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.ticklen number ​

Tick length in px.

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

polar.radialaxis.tickwidth number ​

Tick width in px.

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

polar.radialaxis.tickcolor color ​

Tick color. Defaults to color.

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

polar.radialaxis.ticklabelstep integer ​

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

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

polar.radialaxis.showticklabels boolean ​

Show tick labels.

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

polar.radialaxis.minorloglabels enumerated ​

Log axes whose automatic ticks fall between powers of ten (2, 5 or every digit): small digits labels them with a small digit (2, 5), complete with the full value in the tick font, with tickprefix/ticksuffix (20, 50, 200), none leaves them unlabelled.

  • Type: enumerated
  • Values: "small digits" | "complete" | "none"
  • Default: "small digits"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

polar.radialaxis.tickprefix string ​

Text before each tick label.

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

polar.radialaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

polar.radialaxis.ticksuffix string ​

Text after each tick label.

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

polar.radialaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.tickfont.size number ​

Font size in CSS pixels.

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

polar.radialaxis.tickfont.color color ​

Text color.

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.tickfont.style enumerated ​

Font style.

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: plot

polar.radialaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

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

polar.radialaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

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

polar.radialaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

polar.radialaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

polar.radialaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

polar.radialaxis.layer enumerated ​

Draw the axis line, ticks and labels above or below the traces. Grid lines are always below.

  • Type: enumerated
  • Values: "above traces" | "below traces"
  • Default: "above traces"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.radialaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.radialaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

polar.radialaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

polar.radialaxis.uirevision any ​

Persistence of user-driven changes of this axis (range, angle, rotation). Defaults to the subplot uirevision.

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

polar.radialaxis.type enumerated ​

Radial axis type. '-' detects it from the r data of the first trace on the subplot.

  • Type: enumerated
  • Values: "-" | "linear" | "log" | "date" | "category"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.radialaxis.autorange enumerated ​

Whether the range is computed from the data. reversed autoranges with the axis flipped. min/max autorange only that end and take the other from range (min reversed/max reversed also flip the axis). Defaults to false when a full range is given, to min/max when one end of range is null, and to reversed on a y axis only image traces use (row 0 at the top, as in Plotly).

  • Type: enumerated
  • Values: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max"
  • Default: true
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.autorangeoptions ​

Constraints applied to the computed autorange.

  • Type: object
  • Edit type: plot

polar.radialaxis.autorangeoptions.minallowed any ​

The autoranged minimum is exactly this value (data units).

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

polar.radialaxis.autorangeoptions.maxallowed any ​

The autoranged maximum is exactly this value (data units).

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

polar.radialaxis.autorangeoptions.clipmin any ​

The autoranged minimum is at least this value (data units).

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

polar.radialaxis.autorangeoptions.clipmax any ​

The autoranged maximum is at most this value (data units).

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

polar.radialaxis.autorangeoptions.include any ​

Value(s) the autorange must include (data units).

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

polar.radialaxis.range info_array ​

Visible range [start, end] in data units (numbers, dates or category names; exponents on log axes, as in Plotly). Setting it turns autorange off; null for one end autoranges that end only.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: yes

polar.radialaxis.minallowed any ​

Lowest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

polar.radialaxis.maxallowed any ​

Highest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

polar.radialaxis.autotickangles info_array ​

Candidate angles, in order of preference, for tickangle: auto.

  • Type: info_array [angle, …]
  • Default: [0, 30, 90]
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.rangemode enumerated ​

Linear axes only. tozero: the autorange extends to 0 whatever the data; nonnegative: it stays ≥ 0; normal: it follows the data extremes, like a cartesian axis.

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

polar.radialaxis.angle angle ​

Angle in degrees (counterclockwise from 3 o’clock) along which the radial axis is drawn. Defaults to the first sector angle.

  • Type: angle (degrees)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.side enumerated ​

On which side of the radial axis line its ticks and labels are drawn.

  • Type: enumerated
  • Values: "clockwise" | "counterclockwise"
  • Default: "clockwise"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.radialaxis.title ​

Radial axis title, drawn along the axis.

  • Type: object
  • Edit type: plot

polar.radialaxis.title.text string ​

Radial axis title.

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

polar.radialaxis.title.font ​

Axis title font. Defaults to layout.font with 1.2× size.

  • Type: object
  • Edit type: plot

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.title.font.size number ​

Font size in CSS pixels.

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

polar.radialaxis.title.font.color color ​

Text color.

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.title.font.style enumerated ​

Font style.

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

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.radialaxis.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: plot
  • Animatable: no

polar.angularaxis ​

The angular axis of a polar subplot.

  • Type: object
  • Edit type: calc

polar.angularaxis.visible boolean ​

Draw the axis (line, ticks, labels and grid).

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

polar.angularaxis.showline boolean ​

Draw the axis line.

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

polar.angularaxis.showgrid boolean ​

Draw the grid lines.

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

polar.angularaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.linecolor color ​

Axis line color. Defaults to color.

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

polar.angularaxis.linewidth number ​

Axis line width in px.

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

polar.angularaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.gridwidth number ​

Grid line width in px.

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

polar.angularaxis.griddash string ​

Dash style: solid, dot, dash, longdash, dashdot, longdashdot, or a CSS-like list of dash lengths in px (5px,10px,2px,2px).

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

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.ticklen number ​

Tick length in px.

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

polar.angularaxis.tickwidth number ​

Tick width in px.

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

polar.angularaxis.tickcolor color ​

Tick color. Defaults to color.

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

polar.angularaxis.ticklabelstep integer ​

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

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

polar.angularaxis.showticklabels boolean ​

Show tick labels.

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

polar.angularaxis.minorloglabels enumerated ​

Log axes whose automatic ticks fall between powers of ten (2, 5 or every digit): small digits labels them with a small digit (2, 5), complete with the full value in the tick font, with tickprefix/ticksuffix (20, 50, 200), none leaves them unlabelled.

  • Type: enumerated
  • Values: "small digits" | "complete" | "none"
  • Default: "small digits"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

polar.angularaxis.tickprefix string ​

Text before each tick label.

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

polar.angularaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

polar.angularaxis.ticksuffix string ​

Text after each tick label.

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

polar.angularaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.tickfont.size number ​

Font size in CSS pixels.

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

polar.angularaxis.tickfont.color color ​

Text color.

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

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.tickfont.style enumerated ​

Font style.

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

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.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: plot
  • Animatable: no

polar.angularaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: plot

polar.angularaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

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

polar.angularaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

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

polar.angularaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

polar.angularaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

polar.angularaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

polar.angularaxis.layer enumerated ​

Draw the axis line, ticks and labels above or below the traces. Grid lines are always below.

  • Type: enumerated
  • Values: "above traces" | "below traces"
  • Default: "above traces"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.angularaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.angularaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

polar.angularaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

polar.angularaxis.uirevision any ​

Persistence of user-driven changes of this axis (range, angle, rotation). Defaults to the subplot uirevision.

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

polar.angularaxis.type enumerated ​

Angular axis type. '-' detects it from the theta data of the first trace on the subplot. linear: thetaunit sets how labels read; category: period sets how many categories go around the circle.

  • Type: enumerated
  • Values: "-" | "linear" | "category"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.angularaxis.thetaunit enumerated ​

Unit of the tick labels and hover values of a linear angular axis.

  • Type: enumerated
  • Values: "radians" | "degrees"
  • Default: "degrees"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.period number ​

Number of category positions around the circle of a category angular axis. Defaults to the number of categories.

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

polar.angularaxis.direction enumerated ​

Direction of increasing angles.

  • Type: enumerated
  • Values: "counterclockwise" | "clockwise"
  • Default: "counterclockwise"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.angularaxis.rotation angle ​

Where the angular axis starts, in degrees counterclockwise from 3 o’clock. Defaults to 0 (east) with direction: counterclockwise and 90 (north, like a compass) with clockwise.

  • Type: angle (degrees)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

polar.barmode enumerated ​

barpolar bars at the same angle: stack stacks them outwards, overlay draws them over one another (reduce opacity to see through).

  • Type: enumerated
  • Values: "stack" | "overlay"
  • Default: "stack"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

polar.bargap number ​

Gap between barpolar bars at adjacent angles, as a fraction of the smallest angle difference in the data.

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

polar.uirevision any ​

Persistence of user-driven changes of the axes (unless they set their own). Defaults to layout.uirevision.

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

violinmode enumerated ​

How violines of different traces at the same position combine: side by side (group) or drawn over each other (overlay).

  • Type: enumerated
  • Values: "group" | "overlay"
  • Default: "overlay"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

violingap number ​

Gap between violines at neighboring positions, as a fraction of the position slot.

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

violingroupgap number ​

Gap between the violines of one position in group mode, as a fraction of each one's share.

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

annotations ​

Text annotations with optional arrows (plan E5.4).

  • Type: array of annotation objects; template defaults for every item go in annotationdefaults
  • Edit type: plot

annotations[].visible boolean ​

Draw this annotation.

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

annotations[].text string ​

Text. <br> breaks lines; <b>/<i> around the whole text, <sup>/<sub> digits and entities are rendered, other tags are dropped until rich text (E2.10).

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

annotations[].textangle angle ​

Rotation of the text box, degrees clockwise.

  • Type: angle (degrees)
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].font ​

Text font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

annotations[].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

annotations[].font.size number ​

Font size in CSS pixels.

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

annotations[].font.color color ​

Text color.

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

annotations[].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

annotations[].font.style enumerated ​

Font style.

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

annotations[].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

annotations[].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

annotations[].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

annotations[].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

annotations[].width number ​

Box width (text area), px. Default: the text width.

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

annotations[].height number ​

Box height (text area), px. Default: the text height.

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

annotations[].opacity number ​

Opacity of the whole annotation.

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

annotations[].align enumerated ​

Horizontal alignment of the lines inside the box.

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

annotations[].valign enumerated ​

Vertical alignment of the text inside the box (with height).

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

annotations[].bgcolor color ​

Box background.

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

annotations[].bordercolor color ​

Box border color.

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

annotations[].borderpad number ​

Padding between text and border, px.

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

annotations[].borderwidth number ​

Box border width, px.

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

annotations[].showarrow boolean ​

Draw an arrow from the text to x/y; the text then sits at the tail (ax/ay).

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

annotations[].arrowcolor color ​

Arrow color. Defaults to bordercolor when visible, else #444.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].arrowhead integer ​

End arrowhead: 0 none, 1 wide, 2 narrow, 3 barbed, 4–5 line-drawn, 6 circle, 7 square, 8 bar.

  • Type: integer from 0 to 8
  • Default: 1
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].startarrowhead integer ​

Start arrowhead (0–8).

  • Type: integer from 0 to 8
  • Default: 1
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].arrowside flaglist ​

Which ends get an arrowhead.

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

annotations[].arrowsize number ​

End arrowhead size, relative to arrowwidth.

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

annotations[].startarrowsize number ​

Start arrowhead size, relative to arrowwidth.

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

annotations[].arrowwidth number ​

Arrow line width, px. Defaults to 2 (twice a visible border width).

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

annotations[].standoff number ​

Gap between the arrowhead tip and x/y, px.

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

annotations[].startstandoff number ​

Gap between the text box and the start of the arrow, px.

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

annotations[].ax any ​

Arrow tail x: px from the head (axref: pixel, default −10) or a position in axref units.

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

annotations[].ay any ​

Arrow tail y: px from the head, positive down (ayref: pixel, default −30) or a position in ayref units.

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

annotations[].axref string ​

'pixel', or 'paper' (0–1 across the plot area), an axis id ('x', 'x2': data units of that axis; log axes take exponents, as range does) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "pixel"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].ayref string ​

'pixel', or 'paper' (0–1 across the plot area), an axis id ('x', 'x2': data units of that axis; log axes take exponents, as range does) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "pixel"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].xref string ​

Reference of x: 'paper' (0–1 across the plot area), an axis id ('x', 'x2': data units of that axis; log axes take exponents, as range does) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "x"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].yref string ​

Reference of y: 'paper' (0–1 across the plot area), an axis id ('x', 'x2': data units of that axis; log axes take exponents, as range does) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "y"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].x any ​

Anchor x (the arrow head). Defaults to the middle of the reference.

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

annotations[].y any ​

Anchor y (the arrow head). Defaults to the middle of the reference.

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

annotations[].xanchor enumerated ​

Which side of the text box sits at the anchor (or tail). auto: center with an arrow or a data reference, else by thirds of x.

  • Type: enumerated
  • Values: "auto" | "left" | "center" | "right"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].yanchor enumerated ​

Which side of the text box sits at the anchor (or tail); auto as xanchor.

  • Type: enumerated
  • Values: "auto" | "top" | "middle" | "bottom"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].xshift number ​

Shift the whole annotation right, px.

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].yshift number ​

Shift the whole annotation up, px.

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].clicktoshow enumerated ​

Toggle visible when a data point at xclick/yclick (default x/y) is clicked; onout also hides it on clicks on other points.

  • Type: enumerated
  • Values: false | "onoff" | "onout"
  • Default: false
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].xclick any ​

x of the point that toggles this annotation.

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

annotations[].yclick any ​

y of the point that toggles this annotation.

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

annotations[].hovertext string ​

Hover text (declared; hover labels for annotations are not drawn yet).

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

annotations[].hoverlabel ​

Hover label style (declared; not drawn yet).

  • Type: object
  • Edit type: plot (inherited)

annotations[].hoverlabel.bgcolor color ​

Hover label background.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].hoverlabel.bordercolor color ​

Hover label border.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].hoverlabel.font ​

Hover label font.

  • Type: object
  • Edit type: layout+plot

annotations[].hoverlabel.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

annotations[].hoverlabel.font.size number ​

Font size in CSS pixels.

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

annotations[].hoverlabel.font.color color ​

Text color.

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

annotations[].hoverlabel.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

annotations[].hoverlabel.font.style enumerated ​

Font style.

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

annotations[].hoverlabel.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

annotations[].hoverlabel.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

annotations[].hoverlabel.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

annotations[].hoverlabel.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

annotations[].captureevents boolean ​

Take pointer events over the text box and emit clickannotation on click. Defaults to true with hovertext.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

annotations[].name string ​

Name of this annotation, used to reference it from a template via templateitemname.

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

annotations[].templateitemname string ​

Name of a template annotation to inherit from. If no template item matches, this annotation is hidden (visible: false).

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

images ​

Pictures placed on the figure: logos, backgrounds (plan E5.6).

  • Type: array of image objects; template defaults for every item go in imagedefaults
  • Edit type: plot

images[].visible boolean ​

Draw this image.

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

images[].source string ​

Image URL or data URI (PNG, JPEG, SVG, …). Cross-origin URLs need CORS headers (WebGL cannot draw tainted images).

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

images[].layer enumerated ​

above traces, or below them and the grid (images with a paper reference go under every subplot).

  • Type: enumerated
  • Values: "below" | "above"
  • Default: "above"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

images[].sizex number ​

Width of the image box, in xref units.

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

images[].sizey number ​

Height of the image box, in yref units.

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

images[].sizing enumerated ​

contain: fit inside the box keeping the aspect ratio; fill: cover the box keeping the aspect ratio (cropped); stretch: fill the box exactly.

  • Type: enumerated
  • Values: "fill" | "contain" | "stretch"
  • Default: "contain"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

images[].opacity number ​

Opacity of the image.

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

images[].x any ​

x position of the box, in xref units.

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

images[].y any ​

y position of the box, in yref units.

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

images[].xanchor enumerated ​

Which side of the box sits at x (and where a contained image aligns).

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

images[].yanchor enumerated ​

Which side of the box sits at y (and where a contained image aligns).

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

images[].xref string ​

Reference of x and sizex: 'paper' (0–1 across the plot area), an axis id ('x', 'x2': that axis' range units, so exponents on log axes) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "paper"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

images[].yref string ​

Reference of y and sizey: 'paper' (0–1 across the plot area), an axis id ('x', 'x2': that axis' range units, so exponents on log axes) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "paper"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

images[].name string ​

Name of this image, used to reference it from a template via templateitemname.

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

images[].templateitemname string ​

Name of a template image to inherit from. If no template item matches, this image is hidden (visible: false).

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

legend ​

The legend (E5.2). legend2, legend3, … declare more, referenced from traces' legend ('legend2').

  • Type: object
  • Subplots: also legend2, legend3, … for subplot ids legend2, legend3, …
  • Edit type: legend+layout

legend.visible boolean ​

Draw the legend (with showlegend).

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

legend.bgcolor color ​

Background color. Defaults to paper_bgcolor.

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

legend.bordercolor color ​

Border color.

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

legend.borderwidth number ​

Border width in px.

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

legend.font ​

Item font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

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

legend.font.size number ​

Font size in CSS pixels.

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

legend.font.color color ​

Text color.

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

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

legend.font.style enumerated ​

Font style.

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

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

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

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

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

legend.grouptitlefont ​

Font of the group titles (legendgrouptitle). Defaults to layout.font, 10% larger.

  • Type: object
  • Edit type: layout+plot

legend.grouptitlefont.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

legend.grouptitlefont.size number ​

Font size in CSS pixels.

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

legend.grouptitlefont.color color ​

Text color.

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

legend.grouptitlefont.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

legend.grouptitlefont.style enumerated ​

Font style.

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

legend.grouptitlefont.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

legend.grouptitlefont.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

legend.grouptitlefont.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

legend.grouptitlefont.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

legend.orientation enumerated ​

Stack items vertically (v) or in rows (h).

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

legend.traceorder flaglist ​

Item order: trace order (normal), reversed, grouped by legendgroup, or both. Defaults to grouped when any trace has a legendgroup, else normal.

  • Type: flaglist
  • Flags: "reversed", "grouped" (combine with +)
  • Also accepts: "normal"
  • Default: none
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.tracegroupgap number ​

Gap between legend groups in px (grouped order).

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

legend.entrywidth number ​

Width of each item (h orientation): px or a fraction of the plot width.

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

legend.entrywidthmode enumerated ​

Unit of entrywidth.

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

legend.indentation number ​

Indent of the items in px.

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

legend.itemsizing enumerated ​

Glyph sizes follow the traces (capped) or are constant.

  • Type: enumerated
  • Values: "trace" | "constant"
  • Default: "trace"
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.itemwidth number ​

Width of the glyph area in px.

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

legend.itemclick enumerated ​

What clicking an item does.

  • Type: enumerated
  • Values: "toggle" | "toggleothers" | false
  • Default: "toggle"
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.itemdoubleclick enumerated ​

What double-clicking an item does.

  • Type: enumerated
  • Values: "toggle" | "toggleothers" | false
  • Default: "toggleothers"
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.groupclick enumerated ​

Whether clicks toggle the whole legendgroup or only the item.

  • Type: enumerated
  • Values: "toggleitem" | "togglegroup"
  • Default: "togglegroup"
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.x number ​

Horizontal position (xref fraction). Defaults to 1.02 (v) or 0 (h).

  • Type: number from -2 to 3
  • Default: none
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.xanchor enumerated ​

Which side of the legend sits at x.

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

legend.xref enumerated ​

Reference of x.

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

legend.y number ​

Vertical position (yref fraction). Defaults to 1 (v) or −0.1 (h).

  • Type: number from -2 to 3
  • Default: none
  • Array OK: no
  • Edit type: legend+layout (inherited)
  • Animatable: no

legend.yanchor enumerated ​

Which side sits at y. Defaults to auto (v) or top (h).

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

legend.yref enumerated ​

Reference of y.

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

legend.valign enumerated ​

Vertical alignment of the text with its glyph (multi-line items).

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

legend.maxheight number ​

Maximum height: px, or a fraction (≤ 1) of the plot height (vertical legends beside a paper-referenced plot) or of the figure height (others); taller content scrolls. Defaults to 1 (vertical legends beside the plot) or 0.5; at least 30 px.

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

legend.title ​

Legend title.

  • Type: object
  • Edit type: legend+layout

legend.title.text string ​

Legend title.

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

legend.title.font ​

Title font. Defaults to the legend font.

  • Type: object
  • Edit type: layout+plot

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

legend.title.font.size number ​

Font size in CSS pixels.

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

legend.title.font.color color ​

Text color.

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

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

legend.title.font.style enumerated ​

Font style.

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

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

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

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

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

legend.title.side enumerated ​

Where the title goes. Defaults to top (v) or left (h).

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

legend.uirevision any ​

Keeps legend UI state across updates while unchanged.

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

modebar ​

The modebar: toolbar with zoom, pan, select and export.

  • Type: object
  • Edit type: modebar

modebar.orientation enumerated ​

Lay the buttons out horizontally (h) or vertically (v).

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

modebar.bgcolor color ​

Background of the button groups. Default: paper_bgcolor at half opacity.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

modebar.color color ​

Icon color. Default: layout.font.color at 0.3 opacity.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

modebar.activecolor color ​

Icon color of pressed and hovered buttons. Default: layout.font.color at 0.7 opacity.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

modebar.add info_array ​

Names of built-in buttons to add (e.g. hoverclosest, hovercompare, v1hovermode, togglespikelines).

  • Type: info_array [string, …], any length
  • Default: []
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

modebar.remove info_array ​

Names of buttons to remove (e.g. zoom, pan, select, lasso, zoomin, zoomout, autoscale, resetscale, toimage), case-insensitive.

  • Type: info_array [string, …], any length
  • Default: []
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

modebar.uirevision any ​

Keeps user-driven modebar changes across react while unchanged. Accepted for Plotly compatibility; the modebar has no state of its own yet.

  • Type: any
  • Default: none
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

shapes ​

Lines, rectangles, ellipses and paths in data or paper coordinates (plan E5.5).

  • Type: array of shape objects; template defaults for every item go in shapedefaults
  • Edit type: plot

shapes[].visible enumerated ​

Draw this shape (legendonly hides it until legend entries for shapes land).

  • Type: enumerated
  • Values: true | false | "legendonly"
  • Default: true
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].type enumerated ​

line from (x0,y0) to (x1,y1); rect and circle (an ellipse) inside that box; path draws path. Default: path when path is set, else rect.

  • Type: enumerated
  • Values: "circle" | "rect" | "path" | "line"
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].layer enumerated ​

above traces; below traces and grid lines; between grid lines and traces. Shapes with a paper reference draw under every subplot when not above.

  • Type: enumerated
  • Values: "below" | "above" | "between"
  • Default: "above"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].xref string ​

Reference of the x coordinates: 'paper' (0–1 across the plot area), an axis id ('x', 'x2': data units of that axis — on log axes data values, not exponents; on category axes names or fractional indices) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "x"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].yref string ​

Reference of the y coordinates: 'paper' (0–1 across the plot area), an axis id ('x', 'x2': data units of that axis — on log axes data values, not exponents; on category axes names or fractional indices) or '<axis> domain' (0–1 across that axis' domain).

  • Type: string
  • Default: "y"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].xsizemode enumerated ​

scaled: x0/x1 (and path x values) are in xref units. pixel: they are px offsets from xanchor, so the shape keeps its size when zooming.

  • Type: enumerated
  • Values: "scaled" | "pixel"
  • Default: "scaled"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].ysizemode enumerated ​

scaled: y0/y1 (and path y values) are in yref units. pixel: they are px offsets from yanchor (positive up), so the shape keeps its size when zooming.

  • Type: enumerated
  • Values: "scaled" | "pixel"
  • Default: "scaled"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].xanchor any ​

x anchor (in xref units) of a pixel-sized shape.

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

shapes[].yanchor any ​

y anchor (in yref units) of a pixel-sized shape.

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

shapes[].x0 any ​

Start x. Default: 25% across the reference (px 0 when pixel).

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

shapes[].x1 any ​

End x. Default: 75% across the reference (px 10 when pixel).

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

shapes[].y0 any ​

Start y. Default: 25% up the reference (px 0 when pixel).

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

shapes[].y1 any ​

End y. Default: 75% up the reference (px 10 when pixel).

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

shapes[].path string ​

SVG path (type: path) with coordinates in xref/yref units: M, L, H, V, C, S, Q, T, A, Z and their relative forms. Dates use _ between date and time (2024-01-05_12:00); relative commands and arcs need numbers.

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

shapes[].opacity number ​

Opacity of the shape.

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

shapes[].line ​

Outline.

  • Type: object
  • Edit type: plot (inherited)

shapes[].line.color color ​

Outline color.

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

shapes[].line.width number ​

Outline width, px (0: no outline).

  • Type: number ≥ 0
  • Default: 2
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].line.dash string ​

Dash style: solid, dot, dash, longdash, dashdot, longdashdot or a px list ('5px,10px').

  • Type: string
  • Default: "solid"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].fillcolor color ​

Fill of closed shapes (rect, circle, path; open paths are closed for filling).

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

shapes[].fillrule enumerated ​

How overlapping subpaths of a path fill (SVG fill-rule).

  • Type: enumerated
  • Values: "evenodd" | "nonzero"
  • Default: "evenodd"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].editable boolean ​

Let users drag and resize this shape even when the chart is not editable.

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

shapes[].showlegend boolean ​

Legend entry for this shape (declared; not drawn yet).

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

shapes[].legendgroup string ​

Legend group (declared; not used yet).

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

shapes[].label ​

Text label drawn with the shape.

  • Type: object
  • Edit type: plot (inherited)

shapes[].label.text string ​

Label text (<br> breaks lines).

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

shapes[].label.texttemplate string ​

Label template overriding text (not for paths): %{x0}, %{x1}, %{y0}, %{y1}, %{xcenter}, %{ycenter}, %{dx}, %{dy}, %{width}, %{height}, and for lines %{length} and %{slope}, with d3 formats (%{dx:.2f}).

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

shapes[].label.font ​

Label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

shapes[].label.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

shapes[].label.font.size number ​

Font size in CSS pixels.

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

shapes[].label.font.color color ​

Text color.

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

shapes[].label.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

shapes[].label.font.style enumerated ​

Font style.

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

shapes[].label.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

shapes[].label.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

shapes[].label.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

shapes[].label.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

shapes[].label.textposition enumerated ​

Where the label sits: start/middle/end along lines (default middle), a box position for other shapes (default middle center).

  • Type: enumerated
  • Values: "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" | "start" | "middle" | "end"
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].label.textangle angle ​

Label angle, degrees clockwise. auto: along lines, else 0.

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

shapes[].label.xanchor enumerated ​

Which side of the label sits at its position. auto follows textposition.

  • Type: enumerated
  • Values: "auto" | "left" | "center" | "right"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].label.yanchor enumerated ​

Which side of the label sits at its position. Default: bottom for lines (text above the line), else the vertical part of textposition.

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

shapes[].label.padding number ​

Gap between label and shape, px.

  • Type: number ≥ 0
  • Default: 3
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

shapes[].name string ​

Name of this shape, used to reference it from a template via templateitemname.

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

shapes[].templateitemname string ​

Name of a template shape to inherit from. If no template item matches, this shape is hidden (visible: false).

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

newshape ​

Style of shapes drawn with the draw dragmodes (drawline, drawopenpath, drawclosedpath, drawcircle, drawrect).

  • Type: object
  • Edit type: none

newshape.visible enumerated ​

Draw this shape (legendonly hides it until legend entries for shapes land).

  • Type: enumerated
  • Values: true | false | "legendonly"
  • Default: true
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.showlegend boolean ​

Legend entry for this shape (declared; not drawn yet).

  • Type: boolean
  • Default: false
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.legendgroup string ​

Legend group (declared; not used yet).

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

newshape.line ​

Outline of new shapes.

  • Type: object
  • Edit type: none (inherited)

newshape.line.color color ​

Outline color. Default: a color contrasting with plot_bgcolor (#444 on light, #fff on dark).

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.line.width number ​

Outline width, px.

  • Type: number ≥ 0
  • Default: 4
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.line.dash string ​

Outline dash style (as shapes[].line.dash).

  • Type: string
  • Default: "solid"
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.fillcolor color ​

Fill of new closed shapes (drawopenpath shapes are not filled).

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

newshape.fillrule enumerated ​

How overlapping subpaths of a path fill (SVG fill-rule).

  • Type: enumerated
  • Values: "evenodd" | "nonzero"
  • Default: "evenodd"
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.opacity number ​

Opacity of new shapes (the outline drawn while dragging shows at half of it).

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

newshape.layer enumerated ​

above traces; below traces and grid lines; between grid lines and traces. Shapes with a paper reference draw under every subplot when not above.

  • Type: enumerated
  • Values: "below" | "above" | "between"
  • Default: "above"
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.drawdirection enumerated ​

Constrains drawline, drawrect and drawcircle drags (as in Plotly): diagonal is free; ortho makes lines horizontal or vertical; vertical spans the plot height (rectangles; lines are vertical at the pointer); horizontal spans the plot width.

  • Type: enumerated
  • Values: "ortho" | "horizontal" | "vertical" | "diagonal"
  • Default: "diagonal"
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.label ​

Label of new shapes.

  • Type: object
  • Edit type: none (inherited)

newshape.label.text string ​

Label text of new shapes.

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

newshape.label.texttemplate string ​

Label template of new shapes (as shapes[].label.texttemplate).

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

newshape.label.font ​

Label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

newshape.label.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

newshape.label.font.size number ​

Font size in CSS pixels.

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

newshape.label.font.color color ​

Text color.

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

newshape.label.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

newshape.label.font.style enumerated ​

Font style.

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

newshape.label.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

newshape.label.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

newshape.label.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

newshape.label.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

newshape.label.textposition enumerated ​

Where the label sits: start/middle/end along lines (default middle), a box position for other shapes (default middle center).

  • Type: enumerated
  • Values: "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" | "start" | "middle" | "end"
  • Default: none
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

newshape.label.textangle angle ​

Label angle, degrees clockwise. auto: along lines, else 0.

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

newshape.label.xanchor enumerated ​

Which side of the label sits at its position. auto follows textposition.

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

newshape.label.yanchor enumerated ​

Which side of the label sits at its position. Default: bottom for lines (text above the line), else the vertical part of textposition.

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

newshape.label.padding number ​

Gap between label and shape, px.

  • Type: number ≥ 0
  • Default: 3
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

activeshape ​

The active shape: an editable shape clicked to select it (the eraseshape modebar button removes it).

  • Type: object
  • Edit type: plot

activeshape.fillcolor color ​

Fill of the active shape (open paths stay unfilled).

  • Type: color
  • Default: "rgb(255, 0, 255)"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

activeshape.opacity number ​

Opacity of the active shape.

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

sliders ​

Sliders that step through restyle, relayout, update or animate calls (plan E5.11).

  • Type: array of slider objects; template defaults for every item go in sliderdefaults
  • Edit type: layout

sliders[].visible boolean ​

Show this slider (sliders with fewer than two visible steps are hidden).

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].active number ​

Index of the active step. Moving the slider sets it; it also follows the figure when every step sets the same single attribute.

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

sliders[].steps ​

The steps of the slider.

  • Type: array of step objects; template defaults for every item go in stepdefaults
  • Edit type: layout

sliders[].steps[].visible boolean ​

Include this step. Steps without args (and not method: skip) are always hidden, like in Plotly.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].steps[].method enumerated ​

Chart API method the step calls: restyle, relayout, update (Plotly's update), animate (frames, plan E7.4) or skip (only the events).

  • Type: enumerated
  • Values: "restyle" | "relayout" | "animate" | "update" | "skip"
  • Default: "restyle"
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].steps[].args info_array ​

Arguments of method, as in Plotly: ['attr', value, traces?] or [{ attr: value }, traces?] for restyle, [{ attr: value }] for relayout, [traceUpdate, layoutUpdate, traces?] for update, [frames, options] for animate.

  • Type: info_array [any, …], any length
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].steps[].label string ​

Tick label and current-value text of the step. Default: step-<index>.

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

sliders[].steps[].value string ​

A value identifying the step (in events). Default: label.

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

sliders[].steps[].execute boolean ​

Call method when the step becomes active through the slider. false only moves the slider and emits sliderchange.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].steps[].name string ​

Name of this step, used to reference it from a template via templateitemname.

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

sliders[].steps[].templateitemname string ​

Name of a template step to inherit from. If no template item matches, this step is hidden (visible: false).

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

sliders[].lenmode enumerated ​

Unit of len: a fraction of the plot-area width or px.

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

sliders[].len number ​

Length of the slider, in lenmode units.

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

sliders[].x number ​

Horizontal position, in plot-area (paper) fractions.

  • Type: number from -2 to 3
  • Default: 0
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].xanchor enumerated ​

Which side of the slider sits at x; auto picks one from x.

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

sliders[].y number ​

Vertical position, in plot-area (paper) fractions.

  • Type: number from -2 to 3
  • Default: 0
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].yanchor enumerated ​

Which side of the slider sits at y; auto picks one from y.

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

sliders[].pad ​

Padding around the slider, in px.

  • Type: object
  • Edit type: layout

sliders[].pad.t number ​

Padding above, in px.

  • Type: number
  • Default: 20
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].pad.r number ​

Padding on the right, in px.

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

sliders[].pad.b number ​

Padding below, in px.

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

sliders[].pad.l number ​

Padding on the left, in px.

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

sliders[].transition ​

How the handle moves to a new step (not while dragging).

  • Type: object
  • Edit type: modebar

sliders[].transition.duration number ​

Duration of the handle animation when the active step changes, in ms.

  • Type: number ≥ 0
  • Default: 150
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

sliders[].transition.easing enumerated ​

Easing of the handle animation.

  • Type: enumerated
  • Values: "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out"
  • Default: "cubic-in-out"
  • Array OK: no
  • Edit type: modebar (inherited)
  • Animatable: no

sliders[].currentvalue ​

The current-value label.

  • Type: object
  • Edit type: layout

sliders[].currentvalue.visible boolean ​

Show the current value above the slider.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

sliders[].currentvalue.xanchor enumerated ​

Alignment of the current value over the slider.

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

sliders[].currentvalue.offset number ​

Gap between the current value and the slider, in px.

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

sliders[].currentvalue.prefix string ​

Text before the value (e.g. Year: ).

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

sliders[].currentvalue.suffix string ​

Text after the value.

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

sliders[].currentvalue.font ​

Current-value font. Defaults to the slider font.

  • Type: object
  • Edit type: layout+plot

sliders[].currentvalue.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

sliders[].currentvalue.font.size number ​

Font size in CSS pixels.

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

sliders[].currentvalue.font.color color ​

Text color.

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

sliders[].currentvalue.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

sliders[].currentvalue.font.style enumerated ​

Font style.

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

sliders[].currentvalue.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

sliders[].currentvalue.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

sliders[].currentvalue.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

sliders[].currentvalue.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

sliders[].font ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

sliders[].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

sliders[].font.size number ​

Font size in CSS pixels.

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

sliders[].font.color color ​

Text color.

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

sliders[].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

sliders[].font.style enumerated ​

Font style.

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

sliders[].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

sliders[].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

sliders[].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

sliders[].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

sliders[].bgcolor color ​

Rail and handle background. Default: Plotly's #f8fafc, or a tint of the paper on dark papers.

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

sliders[].activebgcolor color ​

Handle background while dragged or hovered. Default: Plotly's #dbdde0, or a tint of the paper on dark papers.

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

sliders[].bordercolor color ​

Rail and handle border color. Default: Plotly's #bec8d9, or a tint of the paper on dark papers.

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

sliders[].borderwidth number ​

Rail and handle border width, in px.

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

sliders[].ticklen number ​

Length of labeled step ticks, in px.

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

sliders[].tickcolor color ​

Tick color. Default: Plotly's #333, or a tint of the paper on dark papers.

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

sliders[].tickwidth number ​

Tick width, in px.

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

sliders[].minorticklen number ​

Length of unlabeled step ticks, in px.

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

sliders[].name string ​

Name of this slider, used to reference it from a template via templateitemname.

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

sliders[].templateitemname string ​

Name of a template slider to inherit from. If no template item matches, this slider is hidden (visible: false).

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

updatemenus ​

Buttons and dropdowns over the chart that call restyle, relayout, update or animate (plan E5.10).

  • Type: array of updatemenu objects; template defaults for every item go in updatemenudefaults
  • Edit type: layout

updatemenus[].visible boolean ​

Show this menu. Default: true when it has a visible button.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].type enumerated ​

dropdown: a button showing the active item that opens a list; buttons: every button side by side.

  • Type: enumerated
  • Values: "dropdown" | "buttons"
  • Default: "dropdown"
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].direction enumerated ​

Where the buttons go: in a row (left, right) or a column (up, down); for dropdowns, the side the list opens on.

  • Type: enumerated
  • Values: "left" | "right" | "up" | "down"
  • Default: "down"
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].active integer ​

Index of the active button (-1: none). Clicking a button sets it; it also follows the figure when every button sets the same single attribute.

  • Type: integer ≥ -1
  • Default: 0
  • Array OK: no
  • Edit type: modebar
  • Animatable: no

updatemenus[].showactive boolean ​

Highlight the active button (and mark it aria-pressed). Turn off for action buttons.

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

updatemenus[].buttons ​

The buttons of the menu.

  • Type: array of button objects; template defaults for every item go in buttondefaults
  • Edit type: layout

updatemenus[].buttons[].visible boolean ​

Show this button. Default: true when it has args (or method: skip), else false.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].buttons[].method enumerated ​

Chart API method the item calls: restyle, relayout, update (Plotly's update, i.e. chart.updateAttributes), animate (frames, plan E7.4) or skip (only the event).

  • Type: enumerated
  • Values: "restyle" | "relayout" | "animate" | "update" | "skip"
  • Default: "restyle"
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].buttons[].args info_array ​

Arguments of method, as in Plotly: ['attr', value, traces?] or [{ attr: value }, traces?] for restyle, ['attr', value] or [{ attr: value }] for relayout, [traceUpdate, layoutUpdate, traces?] for update, [frames, options] for animate.

  • Type: info_array [any, …], any length
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].buttons[].args2 info_array ​

Arguments of method for a second click: with args2, clicking the active button calls method with args2 and deactivates it (a toggle).

  • Type: info_array [any, …], any length
  • Default: none
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].buttons[].label string ​

Button text (Plotly pseudo-HTML tags are removed).

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

updatemenus[].buttons[].execute boolean ​

Call method on click. false only emits buttonclicked (and leaves active alone), for apps that handle the click themselves.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].buttons[].name string ​

Name of this button, used to reference it from a template via templateitemname.

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

updatemenus[].buttons[].templateitemname string ​

Name of a template button to inherit from. If no template item matches, this button is hidden (visible: false).

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

updatemenus[].x number ​

Horizontal position, in plot-area (paper) fractions.

  • Type: number from -2 to 3
  • Default: -0.05
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].xanchor enumerated ​

Which side of the menu sits at x; auto picks left, center or right from x.

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

updatemenus[].y number ​

Vertical position, in plot-area (paper) fractions.

  • Type: number from -2 to 3
  • Default: 1
  • Array OK: no
  • Edit type: layout (inherited)
  • Animatable: no

updatemenus[].yanchor enumerated ​

Which side of the menu sits at y; auto picks top, middle or bottom from y.

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

updatemenus[].pad ​

Padding around the menu, in px.

  • Type: object
  • Edit type: layout

updatemenus[].pad.t number ​

Padding above, in px.

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

updatemenus[].pad.r number ​

Padding on the right, in px.

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

updatemenus[].pad.b number ​

Padding below, in px.

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

updatemenus[].pad.l number ​

Padding on the left, in px.

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

updatemenus[].font ​

Button font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

updatemenus[].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

updatemenus[].font.size number ​

Font size in CSS pixels.

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

updatemenus[].font.color color ​

Text color.

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

updatemenus[].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

updatemenus[].font.style enumerated ​

Font style.

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

updatemenus[].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

updatemenus[].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

updatemenus[].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

updatemenus[].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

updatemenus[].bgcolor color ​

Button background. Default: paper_bgcolor, or a tint of it on dark papers (the default look).

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

updatemenus[].bordercolor color ​

Button border color. Default: Plotly's #BEC8D9, or a tint of the paper on dark papers.

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

updatemenus[].borderwidth number ​

Button border width, in px.

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

updatemenus[].name string ​

Name of this updatemenu, used to reference it from a template via templateitemname.

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

updatemenus[].templateitemname string ​

Name of a template updatemenu to inherit from. If no template item matches, this updatemenu is hidden (visible: false).

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

hoverdistance number ​

Maximum distance (px) from the pointer to a point for it to be hovered. -1 means no limit; 0 turns hover off for area-like traces only.

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

spikedistance number ​

Maximum distance (px) for spikelines (E3.10). -1 means no limit.

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

clickmode flaglist ​

event emits click with the points under the pointer; select also selects them (shift adds to the selection).

  • Type: flaglist
  • Flags: "event", "select" (combine with +)
  • Also accepts: "none"
  • Default: "event"
  • Array OK: no
  • Edit type: none
  • Animatable: no

selectdirection enumerated ​

Box selection direction: horizontal only (h), vertical only (v), whichever the drag started in (d), or free (any).

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

hoverlabel ​

Default hover label style (traces override it).

  • Type: object
  • Edit type: none

hoverlabel.bgcolor color ​

Label background. Defaults to the point color.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

hoverlabel.bordercolor color ​

Label border. Defaults to a color contrasting with the background.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

hoverlabel.font ​

Label font. Defaults to layout.font at 13 px.

  • Type: object
  • Edit type: none

hoverlabel.font.family string ​

CSS font-family list.

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

hoverlabel.font.size number ​

Font size in CSS pixels.

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

hoverlabel.font.color color ​

Text color.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

hoverlabel.grouptitlefont ​

Title font of unified labels (x unified, y unified).

  • Type: object
  • Edit type: none

hoverlabel.grouptitlefont.family string ​

CSS font-family list.

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

hoverlabel.grouptitlefont.size number ​

Font size in CSS pixels.

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

hoverlabel.grouptitlefont.color color ​

Text color.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

hoverlabel.align enumerated ​

Text alignment inside labels.

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

hoverlabel.namelength integer ​

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

  • Type: integer ≥ -1
  • Default: 15
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

hoverlabel.showarrow boolean ​

Draw the arrow pointing at the point.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: none (inherited)
  • Animatable: no

scene ​

A 3D scene. scene2, scene3, … declare more, referenced from 3D traces' scene ('scene2').

  • Type: object
  • Subplots: also scene2, scene3, … for subplot ids scene2, scene3, …
  • Edit type: plot

scene.domain ​

Extent of the scene as fractions of the plot area, or the layout.grid cell at row / column. Scenes without one sit side by side.

  • Type: object
  • Edit type: plot

scene.domain.x info_array ​

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

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

scene.domain.y info_array ​

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

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

scene.domain.row integer ​

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

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

scene.domain.column integer ​

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

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

scene.bgcolor color ​

Background color of the scene (transparent: the paper shows through).

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

scene.camera ​

The view of the scene. Orbiting, panning and zooming report it in a relayout event ('scene.camera') when the gesture ends.

  • Type: object
  • Edit type: camera

scene.camera.eye ​

Where the camera is, in scene units: the axis box spans aspectratio around the origin ([-x/2, x/2], …).

  • Type: object
  • Edit type: camera

scene.camera.eye.x number ​

x component.

  • Type: number
  • Default: 1.25
  • Array OK: no
  • Edit type: camera
  • Animatable: no

scene.camera.eye.y number ​

y component.

  • Type: number
  • Default: 1.25
  • Array OK: no
  • Edit type: camera
  • Animatable: no

scene.camera.eye.z number ​

z component.

  • Type: number
  • Default: 1.25
  • Array OK: no
  • Edit type: camera
  • Animatable: no

scene.camera.center ​

The point the camera looks at, in scene units.

  • Type: object
  • Edit type: camera

scene.camera.center.x number ​

x component.

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

scene.camera.center.y number ​

y component.

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

scene.camera.center.z number ​

z component.

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

scene.camera.up ​

The direction that points up on the screen. The default puts the z axis up.

  • Type: object
  • Edit type: camera

scene.camera.up.x number ​

x component.

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

scene.camera.up.y number ​

y component.

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

scene.camera.up.z number ​

z component.

  • Type: number
  • Default: 1
  • Array OK: no
  • Edit type: camera
  • Animatable: no

scene.camera.projection ​

The camera projection.

  • Type: object
  • Edit type: camera

scene.camera.projection.type enumerated ​

Perspective (45° vertical field of view) or orthographic projection (the view spans 2 scene units vertically; zooming scales aspectratio).

  • Type: enumerated
  • Values: "perspective" | "orthographic"
  • Default: "perspective"
  • Array OK: no
  • Edit type: camera
  • Animatable: no

scene.aspectmode enumerated ​

cube: the axes form a cube whatever their ranges. data: axis lengths follow their data spans (per axis type). manual: aspectratio. auto (default; manual when aspectratio is given): data unless one axis would be more than 4 times longer than another, then cube.

  • Type: enumerated
  • Values: "auto" | "cube" | "data" | "manual"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.aspectratio ​

Relative lengths of the axes (with aspectmode: manual). The full layout holds the ratio in use for every mode.

  • Type: object
  • Edit type: plot

scene.aspectratio.x number ​

Relative length of the x axis.

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

scene.aspectratio.y number ​

Relative length of the y axis.

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

scene.aspectratio.z number ​

Relative length of the z axis.

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

scene.xaxis ​

An axis of a 3D scene.

  • Type: object
  • Edit type: plot

scene.xaxis.visible boolean ​

Draw the axis (line, ticks, labels, grid and title). A hidden axis still maps data to pixels.

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

scene.xaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.xaxis.autorange enumerated ​

Whether the range is computed from the data. reversed autoranges with the axis flipped. min/max autorange only that end and take the other from range (min reversed/max reversed also flip the axis). Defaults to false when a full range is given, to min/max when one end of range is null, and to reversed on a y axis only image traces use (row 0 at the top, as in Plotly).

  • Type: enumerated
  • Values: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max"
  • Default: true
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.xaxis.autorangeoptions ​

Constraints applied to the computed autorange.

  • Type: object
  • Edit type: plot

scene.xaxis.autorangeoptions.minallowed any ​

The autoranged minimum is exactly this value (data units).

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

scene.xaxis.autorangeoptions.maxallowed any ​

The autoranged maximum is exactly this value (data units).

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

scene.xaxis.autorangeoptions.clipmin any ​

The autoranged minimum is at least this value (data units).

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

scene.xaxis.autorangeoptions.clipmax any ​

The autoranged maximum is at most this value (data units).

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

scene.xaxis.autorangeoptions.include any ​

Value(s) the autorange must include (data units).

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

scene.xaxis.rangemode enumerated ​

Linear axes only. tozero extends the autorange to include 0; nonnegative keeps it ≥ 0.

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

scene.xaxis.range info_array ​

Visible range [start, end] in data units (numbers, dates or category names; exponents on log axes, as in Plotly). Setting it turns autorange off; null for one end autoranges that end only.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: yes

scene.xaxis.minallowed any ​

Lowest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

scene.xaxis.maxallowed any ​

Highest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.mirror enumerated ​

Repeat the axis line on the opposite side of the plot area: true (line), ticks (line and ticks); all/allticks do the same on every subplot sharing this axis.

  • Type: enumerated
  • Values: true | "ticks" | false | "all" | "allticks"
  • Default: false
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.xaxis.ticklen number ​

Tick length in px.

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

scene.xaxis.tickwidth number ​

Tick width in px.

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

scene.xaxis.tickcolor color ​

Tick color. Defaults to color.

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

scene.xaxis.showticklabels boolean ​

Show tick labels.

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

scene.xaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.tickfont.size number ​

Font size in CSS pixels.

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

scene.xaxis.tickfont.color color ​

Text color.

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.tickfont.style enumerated ​

Font style.

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.tickprefix string ​

Text before each tick label.

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

scene.xaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

scene.xaxis.ticksuffix string ​

Text after each tick label.

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

scene.xaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

scene.xaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: plot

scene.xaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

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

scene.xaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

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

scene.xaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.xaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

scene.xaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

scene.xaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

scene.xaxis.showline boolean ​

Draw the axis line.

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

scene.xaxis.linecolor color ​

Axis line color. Defaults to color.

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

scene.xaxis.linewidth number ​

Axis line width in px.

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

scene.xaxis.showgrid boolean ​

Draw grid lines at each tick.

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

scene.xaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.xaxis.gridwidth number ​

Grid line width in px.

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

scene.xaxis.zeroline boolean ​

Draw a line at 0 (linear axes whose range contains 0).

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

scene.xaxis.zerolinecolor color ​

Zero line color. Defaults to color.

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

scene.xaxis.zerolinewidth number ​

Zero line width in px.

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

scene.xaxis.type enumerated ​

Axis type. '-' detects it from this axis' data (x, y or z) of the first trace on the scene.

  • Type: enumerated
  • Values: "-" | "linear" | "log" | "date" | "category"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.xaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.xaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.xaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

scene.xaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

scene.xaxis.title ​

Axis title.

  • Type: object
  • Edit type: plot

scene.xaxis.title.text string ​

Axis title, drawn beside the axis. Defaults to the axis letter ('x').

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

scene.xaxis.title.font ​

Axis title font. Defaults to layout.font with 1.2× size.

  • Type: object
  • Edit type: plot

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.title.font.size number ​

Font size in CSS pixels.

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

scene.xaxis.title.font.color color ​

Text color.

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.title.font.style enumerated ​

Font style.

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

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.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: plot
  • Animatable: no

scene.xaxis.showbackground boolean ​

Fill this axis' wall (the back plane perpendicular to it) with backgroundcolor.

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

scene.xaxis.backgroundcolor color ​

Color of this axis' wall.

  • Type: color
  • Default: "rgba(204, 204, 204, 0.5)"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.xaxis.showaxeslabels boolean ​

Draw the axis title.

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

scene.xaxis.showspikes boolean ​

On hover, draw spikes from the hovered point to this axis' walls (3D hover, plan E14.1d).

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

scene.xaxis.spikesides boolean ​

Extend the spikes from the walls to the edges of the axis box.

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

scene.xaxis.spikethickness number ​

Thickness of the spikes, px.

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

scene.xaxis.spikecolor color ​

Color of the spikes. Defaults to the axis color.

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

scene.yaxis ​

An axis of a 3D scene.

  • Type: object
  • Edit type: plot

scene.yaxis.visible boolean ​

Draw the axis (line, ticks, labels, grid and title). A hidden axis still maps data to pixels.

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

scene.yaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.yaxis.autorange enumerated ​

Whether the range is computed from the data. reversed autoranges with the axis flipped. min/max autorange only that end and take the other from range (min reversed/max reversed also flip the axis). Defaults to false when a full range is given, to min/max when one end of range is null, and to reversed on a y axis only image traces use (row 0 at the top, as in Plotly).

  • Type: enumerated
  • Values: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max"
  • Default: true
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.yaxis.autorangeoptions ​

Constraints applied to the computed autorange.

  • Type: object
  • Edit type: plot

scene.yaxis.autorangeoptions.minallowed any ​

The autoranged minimum is exactly this value (data units).

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

scene.yaxis.autorangeoptions.maxallowed any ​

The autoranged maximum is exactly this value (data units).

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

scene.yaxis.autorangeoptions.clipmin any ​

The autoranged minimum is at least this value (data units).

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

scene.yaxis.autorangeoptions.clipmax any ​

The autoranged maximum is at most this value (data units).

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

scene.yaxis.autorangeoptions.include any ​

Value(s) the autorange must include (data units).

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

scene.yaxis.rangemode enumerated ​

Linear axes only. tozero extends the autorange to include 0; nonnegative keeps it ≥ 0.

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

scene.yaxis.range info_array ​

Visible range [start, end] in data units (numbers, dates or category names; exponents on log axes, as in Plotly). Setting it turns autorange off; null for one end autoranges that end only.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: yes

scene.yaxis.minallowed any ​

Lowest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

scene.yaxis.maxallowed any ​

Highest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.mirror enumerated ​

Repeat the axis line on the opposite side of the plot area: true (line), ticks (line and ticks); all/allticks do the same on every subplot sharing this axis.

  • Type: enumerated
  • Values: true | "ticks" | false | "all" | "allticks"
  • Default: false
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.yaxis.ticklen number ​

Tick length in px.

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

scene.yaxis.tickwidth number ​

Tick width in px.

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

scene.yaxis.tickcolor color ​

Tick color. Defaults to color.

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

scene.yaxis.showticklabels boolean ​

Show tick labels.

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

scene.yaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.tickfont.size number ​

Font size in CSS pixels.

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

scene.yaxis.tickfont.color color ​

Text color.

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.tickfont.style enumerated ​

Font style.

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.tickprefix string ​

Text before each tick label.

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

scene.yaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

scene.yaxis.ticksuffix string ​

Text after each tick label.

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

scene.yaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

scene.yaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: plot

scene.yaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

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

scene.yaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

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

scene.yaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.yaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

scene.yaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

scene.yaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

scene.yaxis.showline boolean ​

Draw the axis line.

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

scene.yaxis.linecolor color ​

Axis line color. Defaults to color.

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

scene.yaxis.linewidth number ​

Axis line width in px.

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

scene.yaxis.showgrid boolean ​

Draw grid lines at each tick.

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

scene.yaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.yaxis.gridwidth number ​

Grid line width in px.

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

scene.yaxis.zeroline boolean ​

Draw a line at 0 (linear axes whose range contains 0).

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

scene.yaxis.zerolinecolor color ​

Zero line color. Defaults to color.

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

scene.yaxis.zerolinewidth number ​

Zero line width in px.

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

scene.yaxis.type enumerated ​

Axis type. '-' detects it from this axis' data (x, y or z) of the first trace on the scene.

  • Type: enumerated
  • Values: "-" | "linear" | "log" | "date" | "category"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.yaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.yaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.yaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

scene.yaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

scene.yaxis.title ​

Axis title.

  • Type: object
  • Edit type: plot

scene.yaxis.title.text string ​

Axis title, drawn beside the axis. Defaults to the axis letter ('x').

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

scene.yaxis.title.font ​

Axis title font. Defaults to layout.font with 1.2× size.

  • Type: object
  • Edit type: plot

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.title.font.size number ​

Font size in CSS pixels.

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

scene.yaxis.title.font.color color ​

Text color.

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.title.font.style enumerated ​

Font style.

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

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.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: plot
  • Animatable: no

scene.yaxis.showbackground boolean ​

Fill this axis' wall (the back plane perpendicular to it) with backgroundcolor.

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

scene.yaxis.backgroundcolor color ​

Color of this axis' wall.

  • Type: color
  • Default: "rgba(204, 204, 204, 0.5)"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.yaxis.showaxeslabels boolean ​

Draw the axis title.

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

scene.yaxis.showspikes boolean ​

On hover, draw spikes from the hovered point to this axis' walls (3D hover, plan E14.1d).

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

scene.yaxis.spikesides boolean ​

Extend the spikes from the walls to the edges of the axis box.

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

scene.yaxis.spikethickness number ​

Thickness of the spikes, px.

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

scene.yaxis.spikecolor color ​

Color of the spikes. Defaults to the axis color.

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

scene.zaxis ​

An axis of a 3D scene.

  • Type: object
  • Edit type: plot

scene.zaxis.visible boolean ​

Draw the axis (line, ticks, labels, grid and title). A hidden axis still maps data to pixels.

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

scene.zaxis.color color ​

Base color of the axis: the default for linecolor, tickcolor, zerolinecolor, dividercolor and (when changed) the tick-label and title font colors.

  • Type: color
  • Default: "#444"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.zaxis.autorange enumerated ​

Whether the range is computed from the data. reversed autoranges with the axis flipped. min/max autorange only that end and take the other from range (min reversed/max reversed also flip the axis). Defaults to false when a full range is given, to min/max when one end of range is null, and to reversed on a y axis only image traces use (row 0 at the top, as in Plotly).

  • Type: enumerated
  • Values: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max"
  • Default: true
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.zaxis.autorangeoptions ​

Constraints applied to the computed autorange.

  • Type: object
  • Edit type: plot

scene.zaxis.autorangeoptions.minallowed any ​

The autoranged minimum is exactly this value (data units).

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

scene.zaxis.autorangeoptions.maxallowed any ​

The autoranged maximum is exactly this value (data units).

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

scene.zaxis.autorangeoptions.clipmin any ​

The autoranged minimum is at least this value (data units).

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

scene.zaxis.autorangeoptions.clipmax any ​

The autoranged maximum is at most this value (data units).

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

scene.zaxis.autorangeoptions.include any ​

Value(s) the autorange must include (data units).

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

scene.zaxis.rangemode enumerated ​

Linear axes only. tozero extends the autorange to include 0; nonnegative keeps it ≥ 0.

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

scene.zaxis.range info_array ​

Visible range [start, end] in data units (numbers, dates or category names; exponents on log axes, as in Plotly). Setting it turns autorange off; null for one end autoranges that end only.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: yes

scene.zaxis.minallowed any ​

Lowest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

scene.zaxis.maxallowed any ​

Highest value zoom and pan may reach, in range units (like range: exponents on log axes). Also caps the autorange.

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.mirror enumerated ​

Repeat the axis line on the opposite side of the plot area: true (line), ticks (line and ticks); all/allticks do the same on every subplot sharing this axis.

  • Type: enumerated
  • Values: true | "ticks" | false | "all" | "allticks"
  • Default: false
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.zaxis.ticklen number ​

Tick length in px.

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

scene.zaxis.tickwidth number ​

Tick width in px.

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

scene.zaxis.tickcolor color ​

Tick color. Defaults to color.

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

scene.zaxis.showticklabels boolean ​

Show tick labels.

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

scene.zaxis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.tickfont.size number ​

Font size in CSS pixels.

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

scene.zaxis.tickfont.color color ​

Text color.

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.tickfont.style enumerated ​

Font style.

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.tickprefix string ​

Text before each tick label.

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

scene.zaxis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

scene.zaxis.ticksuffix string ​

Text after each tick label.

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

scene.zaxis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

scene.zaxis.showexponent enumerated ​

Which tick labels show the exponent.

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.tickformatstops ​

Zoom-dependent tick formats: the first enabled stop whose dtickrange contains the current tick step replaces tickformat.

  • Type: array of tickformatstop objects; template defaults for every item go in tickformatstopdefaults
  • Edit type: plot

scene.zaxis.tickformatstops[].enabled boolean ​

Whether this stop is used.

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

scene.zaxis.tickformatstops[].visible boolean ​

Set to false (by the template machinery) when templateitemname names no template stop; hidden stops are ignored like disabled ones.

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

scene.zaxis.tickformatstops[].dtickrange info_array ​

Range [min, max] of the tick step (dtick) this format applies to; null for an open end. Date steps are in ms or M<n>.

  • Type: info_array [any, any]
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.zaxis.tickformatstops[].value string ​

The tickformat to use while the tick step is inside dtickrange.

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

scene.zaxis.tickformatstops[].name string ​

Name of this tickformatstop, used to reference it from a template via templateitemname.

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

scene.zaxis.tickformatstops[].templateitemname string ​

Name of a template tickformatstop to inherit from. If no template item matches, this tickformatstop is hidden (visible: false).

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

scene.zaxis.showline boolean ​

Draw the axis line.

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

scene.zaxis.linecolor color ​

Axis line color. Defaults to color.

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

scene.zaxis.linewidth number ​

Axis line width in px.

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

scene.zaxis.showgrid boolean ​

Draw grid lines at each tick.

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

scene.zaxis.gridcolor color ​

Grid line color.

  • Type: color
  • Default: "#eee"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.zaxis.gridwidth number ​

Grid line width in px.

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

scene.zaxis.zeroline boolean ​

Draw a line at 0 (linear axes whose range contains 0).

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

scene.zaxis.zerolinecolor color ​

Zero line color. Defaults to color.

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

scene.zaxis.zerolinewidth number ​

Zero line width in px.

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

scene.zaxis.type enumerated ​

Axis type. '-' detects it from this axis' data (x, y or z) of the first trace on the scene.

  • Type: enumerated
  • Values: "-" | "linear" | "log" | "date" | "category"
  • Default: "-"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.zaxis.autotypenumbers enumerated ​

How type detection treats numeric strings: convert types counts '12' as a number; strict counts only real numbers, so numeric strings make a category axis.

  • Type: enumerated
  • Values: "convert types" | "strict"
  • Default: "convert types"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.zaxis.categoryorder enumerated ​

Order of categories: as they first appear in the traces (trace), alphabetical/numerical (category ascending|descending), categoryarray first (array), or by an aggregate of the trace values per category (total, min, max, sum, mean, median). Defaults to array when categoryarray is set, else trace.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

scene.zaxis.categoryarray data_array ​

Category order for categoryorder: array. Categories not listed follow in trace order.

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

scene.zaxis.hoverformat string ​

Format of this axis’ values in hover labels (same syntax as tickformat). Empty uses the tick format with extra precision.

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

scene.zaxis.title ​

Axis title.

  • Type: object
  • Edit type: plot

scene.zaxis.title.text string ​

Axis title, drawn beside the axis. Defaults to the axis letter ('x').

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

scene.zaxis.title.font ​

Axis title font. Defaults to layout.font with 1.2× size.

  • Type: object
  • Edit type: plot

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.title.font.size number ​

Font size in CSS pixels.

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

scene.zaxis.title.font.color color ​

Text color.

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.title.font.style enumerated ​

Font style.

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

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.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: plot
  • Animatable: no

scene.zaxis.showbackground boolean ​

Fill this axis' wall (the back plane perpendicular to it) with backgroundcolor.

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

scene.zaxis.backgroundcolor color ​

Color of this axis' wall.

  • Type: color
  • Default: "rgba(204, 204, 204, 0.5)"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.zaxis.showaxeslabels boolean ​

Draw the axis title.

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

scene.zaxis.showspikes boolean ​

On hover, draw spikes from the hovered point to this axis' walls (3D hover, plan E14.1d).

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

scene.zaxis.spikesides boolean ​

Extend the spikes from the walls to the edges of the axis box.

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

scene.zaxis.spikethickness number ​

Thickness of the spikes, px.

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

scene.zaxis.spikecolor color ​

Color of the spikes. Defaults to the axis color.

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

scene.dragmode enumerated ​

What dragging does: orbit rotates freely, turntable rotates about the z axis (keeping it up), zoom moves the camera closer, pan moves it sideways; false turns dragging off. Defaults to layout.dragmode when the figure has only 3D subplots and that is one of these, else turntable (or orbit when camera.up isn't the z axis).

  • Type: enumerated
  • Values: "orbit" | "turntable" | "zoom" | "pan" | false
  • Default: none
  • Array OK: no
  • Edit type: modebar
  • Animatable: no

scene.hovermode enumerated ​

Hover labels on the scene (closest) or none (false).

  • Type: enumerated
  • Values: "closest" | false
  • Default: "closest"
  • Array OK: no
  • Edit type: modebar
  • Animatable: no

scene.uirevision any ​

Persistence of user-driven camera changes. Accepted for Plotly compatibility; layout.uirevision governs them.

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

scene.annotations ​

Annotations anchored at 3D data points: 2D annotation text and arrows at the projected point, following the camera.

  • Type: array of annotation objects; template defaults for every item go in annotationdefaults
  • Edit type: plot

scene.annotations[].visible boolean ​

Draw this annotation.

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

scene.annotations[].text string ​

Text. <br> breaks lines; <b>/<i> around the whole text, <sup>/<sub> digits and entities are rendered, other tags are dropped until rich text (E2.10).

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

scene.annotations[].textangle angle ​

Rotation of the text box, degrees clockwise.

  • Type: angle (degrees)
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].font ​

Text font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

scene.annotations[].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

scene.annotations[].font.size number ​

Font size in CSS pixels.

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

scene.annotations[].font.color color ​

Text color.

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

scene.annotations[].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

scene.annotations[].font.style enumerated ​

Font style.

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

scene.annotations[].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

scene.annotations[].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

scene.annotations[].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

scene.annotations[].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

scene.annotations[].width number ​

Box width (text area), px. Default: the text width.

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

scene.annotations[].height number ​

Box height (text area), px. Default: the text height.

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

scene.annotations[].opacity number ​

Opacity of the whole annotation.

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

scene.annotations[].align enumerated ​

Horizontal alignment of the lines inside the box.

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

scene.annotations[].valign enumerated ​

Vertical alignment of the text inside the box (with height).

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

scene.annotations[].bgcolor color ​

Box background.

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

scene.annotations[].bordercolor color ​

Box border color.

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

scene.annotations[].borderpad number ​

Padding between text and border, px.

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

scene.annotations[].borderwidth number ​

Box border width, px.

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

scene.annotations[].showarrow boolean ​

Draw an arrow from the text to x/y; the text then sits at the tail (ax/ay).

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

scene.annotations[].arrowcolor color ​

Arrow color. Defaults to bordercolor when visible, else #444.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].arrowhead integer ​

End arrowhead: 0 none, 1 wide, 2 narrow, 3 barbed, 4–5 line-drawn, 6 circle, 7 square, 8 bar.

  • Type: integer from 0 to 8
  • Default: 1
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].startarrowhead integer ​

Start arrowhead (0–8).

  • Type: integer from 0 to 8
  • Default: 1
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].arrowside flaglist ​

Which ends get an arrowhead.

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

scene.annotations[].arrowsize number ​

End arrowhead size, relative to arrowwidth.

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

scene.annotations[].startarrowsize number ​

Start arrowhead size, relative to arrowwidth.

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

scene.annotations[].arrowwidth number ​

Arrow line width, px. Defaults to 2 (twice a visible border width).

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

scene.annotations[].standoff number ​

Gap between the arrowhead tip and x/y, px.

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

scene.annotations[].startstandoff number ​

Gap between the text box and the start of the arrow, px.

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

scene.annotations[].xanchor enumerated ​

Which side of the text box sits at the anchor (or tail). auto: center with an arrow or a data reference, else by thirds of x.

  • Type: enumerated
  • Values: "auto" | "left" | "center" | "right"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].yanchor enumerated ​

Which side of the text box sits at the anchor (or tail); auto as xanchor.

  • Type: enumerated
  • Values: "auto" | "top" | "middle" | "bottom"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].xshift number ​

Shift the whole annotation right, px.

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].yshift number ​

Shift the whole annotation up, px.

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].hovertext string ​

Hover text (declared; hover labels for annotations are not drawn yet).

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

scene.annotations[].hoverlabel ​

Hover label style (declared; not drawn yet).

  • Type: object
  • Edit type: plot (inherited)

scene.annotations[].hoverlabel.bgcolor color ​

Hover label background.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].hoverlabel.bordercolor color ​

Hover label border.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].hoverlabel.font ​

Hover label font.

  • Type: object
  • Edit type: layout+plot

scene.annotations[].hoverlabel.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

scene.annotations[].hoverlabel.font.size number ​

Font size in CSS pixels.

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

scene.annotations[].hoverlabel.font.color color ​

Text color.

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

scene.annotations[].hoverlabel.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

scene.annotations[].hoverlabel.font.style enumerated ​

Font style.

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

scene.annotations[].hoverlabel.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

scene.annotations[].hoverlabel.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

scene.annotations[].hoverlabel.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

scene.annotations[].hoverlabel.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

scene.annotations[].captureevents boolean ​

Take pointer events over the text box and emit clickannotation on click. Defaults to true with hovertext.

  • Type: boolean
  • Default: none
  • Array OK: no
  • Edit type: plot (inherited)
  • Animatable: no

scene.annotations[].x any ​

The x of the annotated point, in the scene x axis' data.

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

scene.annotations[].y any ​

The y of the annotated point, in the scene y axis' data.

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

scene.annotations[].z any ​

The z of the annotated point, in the scene z axis' data.

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

scene.annotations[].ax number ​

Arrow tail (the text) x offset from the point, px. Default −10.

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

scene.annotations[].ay number ​

Arrow tail (the text) y offset from the point, px, positive down. Default −30.

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

scene.annotations[].name string ​

Name of this annotation, used to reference it from a template via templateitemname.

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

scene.annotations[].templateitemname string ​

Name of a template annotation to inherit from. If no template item matches, this annotation is hidden (visible: false).

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

scene.lighting ​

The scene's lights (Holochart extension). Unset, traces are lit as in Plotly (each by its lightposition); set, these lights light every trace of the scene (Plotly's model scales them by the trace's lighting).

  • Type: object
  • Edit type: plot

scene.lighting.ambient ​

Light reaching every surface from every direction.

  • Type: object
  • Edit type: plot

scene.lighting.ambient.color color ​

Ambient color.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.lighting.ambient.intensity number ​

Ambient intensity (1: the full color).

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

scene.lighting.directional ​

Directional lights (like the sun). Default: one light at Plotly's default lightposition (clip space (1e5, 1e5, 0)); [] for none.

  • Type: array of light objects; template defaults for every item go in lightdefaults
  • Edit type: plot

scene.lighting.directional[].visible boolean ​

Whether this light shines.

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

scene.lighting.directional[].color color ​

Light color.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.lighting.directional[].intensity number ​

Light intensity (1: the full color).

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

scene.lighting.directional[].position ​

Where the light shines from (see space). Default (1, 1, 1) ((1e5, 1e5, 0) in clip space).

  • Type: object
  • Edit type: plot

scene.lighting.directional[].position.x number ​

x component.

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

scene.lighting.directional[].position.y number ​

y component.

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

scene.lighting.directional[].position.z number ​

z component.

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

scene.lighting.directional[].space enumerated ​

scene: a direction in scene units, fixed to the data (the light shines from position toward the scene's center). camera: a direction in view space (x right, y up, z toward the viewer), moving with the view. clip: Plotly's lightposition space, moving with the view.

  • Type: enumerated
  • Values: "scene" | "camera" | "clip"
  • Default: "scene"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.lighting.directional[].castshadow boolean ​

Cast shadows (from traces with material.castshadow, onto three.js material types with material.receiveshadow and the ground plane).

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

scene.lighting.directional[].name string ​

Name of this light, used to reference it from a template via templateitemname.

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

scene.lighting.directional[].templateitemname string ​

Name of a template light to inherit from. If no template item matches, this light is hidden (visible: false).

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

scene.lighting.hemisphere ​

Sky and ground light blended by the surfaces' orientation to the scene's z axis.

  • Type: object
  • Edit type: plot

scene.lighting.hemisphere.skycolor color ​

Color from above.

  • Type: color
  • Default: "#fff"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.lighting.hemisphere.groundcolor color ​

Color from below.

  • Type: color
  • Default: "#4d4d4d"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.lighting.hemisphere.intensity number ​

Intensity. The hemisphere light is on when hemisphere is given.

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

scene.lighting.environment string ​

Image-based lighting and reflections for the standard, physical, phong and basic material types: 'studio', 'city' (built-in rooms) or the URL of an equirectangular image.

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

scene.lighting.environmentintensity number ​

Strength of the environment's light.

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

scene.lighting.shadows ​

Shadows of lights with castshadow.

  • Type: object
  • Edit type: plot

scene.lighting.shadows.ground boolean ​

A ground plane catching shadows, below the scene's axis box.

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

scene.lighting.shadows.extent number ​

Half-size of the shadowed region, scene units. Default: large enough for the axis box.

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

scene.lighting.shadows.mapsize integer ​

Shadow map size, px.

  • Type: integer from 64 to 8192
  • Default: 1024
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scene.lighting.shadows.opacity number ​

Darkness of the ground plane's shadows.

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

scene.autorotate ​

Turn the scene continuously, like a turntable (Holochart extension). The rotation pauses while the user moves the camera and carries on from the new view when the camera comes to rest; it runs only while the chart is on screen, and not at all with reduced motion (prefers-reduced-motion). The layout camera doesn't follow the rotation: relayout reports the camera when a gesture or animateCamera ends, or the rotation stops.

  • Type: object
  • Edit type: camera

scene.autorotate.speed number ​

Degrees per second the scene turns, counterclockwise seen from the positive end of axis (negative: clockwise). Default 15 when autorotate is given, else 0 (off).

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

scene.autorotate.axis enumerated ​

The axis the scene turns about, through the camera's center.

  • Type: enumerated
  • Values: "x" | "y" | "z"
  • Default: "z"
  • Array OK: no
  • Edit type: camera
  • Animatable: no

scene.autorotate.time number ​

Freeze the rotation at this many seconds after the start (the layout camera turned by speed × time): a fixed frame for exports and tests.

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

view3d ​

The 2.5D view (Holochart extension): every cartesian subplot in perspective, its plot area a tilted plane; axes, hover, zoom and selection keep working.

  • Type: object
  • Edit type: plot

view3d.enabled boolean ​

Show the cartesian subplots in perspective (2.5D).

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

view3d.tilt number ​

Elevation of the view, degrees: positive looks from above (the tops of vertical bars show).

  • Type: number from -80 to 80
  • Default: 20
  • Array OK: no
  • Edit type: camera
  • Animatable: yes

view3d.rotation number ​

Azimuth of the view, degrees: positive looks from the right (right sides show).

  • Type: number from -80 to 80
  • Default: -20
  • Array OK: no
  • Edit type: camera
  • Animatable: yes

view3d.perspective number ​

Strength of the perspective: 0 is a parallel projection, 1 a strong one.

  • Type: number from 0 to 1
  • Default: 0.5
  • Array OK: no
  • Edit type: camera
  • Animatable: yes

view3d.interactive boolean ​

With dragmode 'turntable' or 'orbit', dragging the plot area turns the view.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: camera
  • Animatable: no

Released under the MIT License.

Copyright © 2026 Holochart contributors