Skip to content

scatter3d attributes ​

Markers, lines and text at x/y/z in a 3D scene, with colorscales, sprite or lit-sphere markers, 3D error bars, wall projections and a surface through the points; one GPU draw call per part whatever the point count.

  • Categories: gl3d, symbols, showLegend
  • Plotly equivalent: scatter3d
  • Guide: scatter3d chart page
  • Used in examples: demos/dallas-weather/climate-spiral, demos/index-funds/risk-3d, demos/index-funds/rolling-return-surface, demos/science-basics/field-cones, demos/science-basics/inverse-square, demos/science-basics/magnet-streamtube, demos/science-basics/methane-shape, demos/science-basics/molecules, demos/tqqq-soxl/decay-surface, scatter3d/annotations, scatter3d/axis-types, scatter3d/basic, scatter3d/error-bars, scatter3d/helix, scatter3d/interaction, scatter3d/multiple-traces, scatter3d/perf-1m, scatter3d/projections, scatter3d/ribbons, scatter3d/spheres, scatter3d/surfaceaxis, scatter3d/symbols, scatter3d/text, scatter3d/tube, scene/aspect, scene/autorotate, scene/camera-tween, scene/default-camera, scene/plotly-look, scene/subplots, scene/walls

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

Attribute tree

type string ​

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

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

visible enumerated ​

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

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

name string ​

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

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

uid string ​

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

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

showlegend boolean ​

Whether this trace has a legend entry.

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

legend subplotid ​

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

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

legendgroup string ​

Traces in the same legend group toggle together.

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

hovertext string ​

Hover text per point; defaults to text.

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

hoverinfo flaglist ​

Which fields hover labels show; 'skip' also turns hover events off for this trace. Default 'all'.

  • Type: flaglist
  • Flags: "x", "y", "z", "text", "name" (combine with +)
  • Also accepts: "all" | "none" | "skip"
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hovertemplate string ​

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

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

hoverlabel ​

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

  • Type: object
  • Edit type: none

hoverlabel.bgcolor color ​

Label background. Default: the point color.

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

hoverlabel.bordercolor color ​

Label border. Default: contrasting with the background.

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

hoverlabel.font ​

Label font.

  • Type: object
  • Edit type: none

hoverlabel.font.family string ​

Font family.

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

hoverlabel.font.size number ​

Font size in px.

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

hoverlabel.font.color color ​

Font color.

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

hoverlabel.align enumerated ​

Text alignment inside labels.

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

hoverlabel.namelength integer ​

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

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

selectedpoints any ​

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

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

legendrank number ​

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

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

legendwidth number ​

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

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

legendgrouptitle ​

Title of the legend group this trace belongs to.

  • Type: object
  • Edit type: legend

legendgrouptitle.text string ​

Title heading this trace's legend group.

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

legendgrouptitle.font ​

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

  • Type: object
  • Edit type: legend

legendgrouptitle.font.family string ​

Font family.

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

legendgrouptitle.font.size number ​

Font size in px.

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

legendgrouptitle.font.color color ​

Font color.

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

legendgrouptitle.font.weight integer ​

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

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

legendgrouptitle.font.style enumerated ​

Font style.

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

opacity number ​

Opacity of the whole trace.

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

meta any ​

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

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

customdata data_array ​

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

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

ids data_array ​

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

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

dataset string ​

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

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

uirevision any ​

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

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

styleRules any ​

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

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

scene subplotid ​

The 3D scene this trace is drawn in: 'scene' (layout.scene), 'scene2' (layout.scene2), ….

  • Type: subplotid (scene, scene2, scene3, …)
  • Default: "scene"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

x data_array ​

The x coordinates (numbers, dates or categories, per the scene's x axis).

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

y data_array ​

The y coordinates (numbers, dates or categories, per the scene's y axis).

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

z data_array ​

The z coordinates (numbers, dates or categories, per the scene's z axis).

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

mode flaglist ​

Drawing mode: any of 'lines', 'markers', 'text' joined by +, or 'none'.

  • Type: flaglist
  • Flags: "lines", "markers", "text" (combine with +)
  • Also accepts: "none"
  • Default: "lines+markers"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

text string ​

Text per point: the labels of mode text, and hover text.

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

texttemplate string ​

Template for the text labels, e.g. '%{y:.2f}' or '%{x|%b %d}' (d3-format / d3-time-format after : / |). Keys: x, y, text, customdata, marker.size, marker.color, meta. Overrides text.

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

textposition enumerated ​

Position of each text label around its point (and marker), or one per point; the labels face the camera.

  • Type: enumerated
  • Values: "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right"
  • Default: "top center"
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

textfont ​

Font of the text labels (mode text). Defaults to layout.font.

  • Type: object
  • Edit type: plot

textfont.family string ​

CSS font family of the text labels, or one per point.

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

textfont.size number ​

Font size in CSS px, or one per point.

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

textfont.color color ​

Text color, or one per point.

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

textfont.weight integer ​

Font weight: a CSS numeric weight, normal or bold.

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

textfont.style enumerated ​

Font style.

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

xhoverformat string ​

d3-format (or d3-time-format on date axes) of the x values in hover labels, overriding the scene axis' hoverformat.

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

yhoverformat string ​

d3-format (or d3-time-format on date axes) of the y values in hover labels, overriding the scene axis' hoverformat.

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

zhoverformat string ​

d3-format (or d3-time-format on date axes) of the z values in hover labels, overriding the scene axis' hoverformat.

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

connectgaps boolean ​

Connect lines across missing (null, NaN) points instead of breaking them.

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

line ​

Line style (mode lines).

  • Type: object
  • Edit type: plot

line.color color ​

Line color, or one per point (numbers map through line.colorscale; the color is interpolated along each segment). Defaults to the marker color (when a single color) or the colorway.

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

line.colorscale colorscale ​

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

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

line.autocolorscale boolean ​

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

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

line.reversescale boolean ​

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

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

line.cauto boolean ​

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

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

line.cmin number ​

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

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

line.cmax number ​

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

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

line.cmid number ​

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

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

line.showscale boolean ​

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

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

line.colorbar ​

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

  • Type: object
  • Edit type: colorbars+layout

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

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

line.colorbar.thickness number ​

Thickness of the color bar.

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

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

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

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

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

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

line.colorbar.xpad number ​

Horizontal padding, px.

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

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

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

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

line.colorbar.ypad number ​

Vertical padding, px.

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

line.colorbar.outlinecolor color ​

Color of the outline around the bar.

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

line.colorbar.outlinewidth number ​

Outline width, px.

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

line.colorbar.bordercolor color ​

Border color of the colorbar box.

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

line.colorbar.borderwidth number ​

Border width of the box, px.

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

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

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

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

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

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

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

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

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

line.colorbar.ticklen number ​

Tick length in px.

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

line.colorbar.tickwidth number ​

Tick width in px.

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

line.colorbar.tickcolor color ​

Tick color. Defaults to color.

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

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

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

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

line.colorbar.showticklabels boolean ​

Show tick labels.

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

line.colorbar.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

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

line.colorbar.tickfont.size number ​

Font size in CSS pixels.

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

line.colorbar.tickfont.color color ​

Text color.

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

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

line.colorbar.tickfont.style enumerated ​

Font style.

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

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

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

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

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

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

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

line.colorbar.tickprefix string ​

Text before each tick label.

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

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

line.colorbar.ticksuffix string ​

Text after each tick label.

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

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

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

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

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

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

line.colorbar.title ​

Colorbar title.

  • Type: object
  • Edit type: colorbars+layout

line.colorbar.title.text string ​

Colorbar title.

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

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

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

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

line.colorbar.title.font.color color ​

Text color.

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

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

line.colorbar.title.font.style enumerated ​

Font style.

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

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

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

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

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

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

line.coloraxis subplotid ​

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

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

line.width number ​

Line width in CSS px, at every depth (screen-space lines).

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

line.dash enumerated ​

Dash style, measured in CSS px along the drawn line (render: "screen" only).

  • Type: enumerated
  • Values: "dash" | "dashdot" | "dot" | "longdash" | "longdashdot" | "solid"
  • Default: "solid"
  • Array OK: no
  • Edit type: style
  • Animatable: no

line.render enumerated ​

How the line is drawn (a Holochart extension): 'screen' — Plotly's look, a flat band width CSS px wide at every depth; 'tube' — a lit tube of radius around the line; 'ribbon' — a lit strip swept along an axis (ribbon), e.g. waterfall plots of spectra. Tubes and ribbons are meshes: they scale with the view like the data, and take lighting, lightposition and material.

  • Type: enumerated
  • Values: "screen" | "tube" | "ribbon"
  • Default: "screen"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

line.radius number ​

Tube radius (render: 'tube') as a fraction of the longest side of the scene's axis box (so tubes stay round whatever the axis scales).

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

line.ribbon ​

The ribbon of render: 'ribbon'.

  • Type: object
  • Edit type: calc

line.ribbon.axis enumerated ​

The axis the ribbon extends along (on both sides of the line).

  • Type: enumerated
  • Values: "x" | "y" | "z"
  • Default: "y"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

line.ribbon.width number ​

Ribbon width along axis, in that axis' units (a category is 1, dates in ms). Default: a twentieth of the axis range.

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

line.lighting ​

Plotly's lighting model: coefficients of the ambient, diffuse and specular light. With scene.lighting, they scale the scene's lights.

  • Type: object
  • Edit type: calc

line.lighting.ambient number ​

Ambient light: the share of the color shown whatever the direction of the light.

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

line.lighting.diffuse number ​

Diffuse light: the share of the color lit by the light (Lambert).

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

line.lighting.specular number ​

Specular highlights: the light reflected toward the eye.

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

line.lighting.roughness number ​

Roughness of the surface: the spread of the specular highlights.

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

line.lighting.fresnel number ​

Fresnel reflection: how much more light surfaces reflect at grazing angles.

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

line.lightposition ​

Position of the light (Plotly's model, without scene.lighting), in clip space: it moves with the view.

  • Type: object
  • Edit type: calc

line.lightposition.x number ​

x of the light, in clip space (moves with the view; ±1 is the edge of the view, 1e5 far away).

  • Type: number from -100000 to 100000
  • Default: 100000
  • Array OK: no
  • Edit type: calc
  • Animatable: no

line.lightposition.y number ​

y of the light, in clip space (moves with the view; ±1 is the edge of the view, 1e5 far away).

  • Type: number from -100000 to 100000
  • Default: 100000
  • Array OK: no
  • Edit type: calc
  • Animatable: no

line.lightposition.z number ​

z of the light, in clip space (moves with the view; ±1 is the edge of the view, 1e5 far away).

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

line.material ​

The material of the surface (Holochart extension). Plotly figures keep the default, plotly.

  • Type: object
  • Edit type: calc

line.material.type enumerated ​

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

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

line.material.roughness number ​

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

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

line.material.metalness number ​

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

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

line.material.shininess number ​

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

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

line.material.specular color ​

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

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

line.material.emissive color ​

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

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

line.material.emissiveintensity number ​

Strength of emissive. Default 1.

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

line.material.reflectivity number ​

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

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

line.material.envmapintensity number ​

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

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

line.material.clearcoat number ​

A clear lacquer layer (physical). Default 0.

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

line.material.clearcoatroughness number ​

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

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

line.material.transmission number ​

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

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

line.material.ior number ​

Index of refraction (physical). Default 1.5.

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

line.material.thickness number ​

Thickness of transmissive volumes, scene units (physical).

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

line.material.sheen number ​

Velvet-like sheen (physical). Default 0.

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

line.material.sheencolor color ​

Color of the sheen (physical).

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

line.material.sheenroughness number ​

Roughness of the sheen (physical). Default 1.

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

line.material.iridescence number ​

Thin-film iridescence (physical). Default 0.

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

line.material.steps integer ​

Number of shading bands (toon).

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

line.material.matcap string ​

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

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

line.material.castshadow boolean ​

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

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

line.material.receiveshadow boolean ​

Receive shadows (three.js material types only).

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

marker ​

Marker style (mode markers).

  • Type: object
  • Edit type: plot

marker.color color ​

Marker fill color, one CSS color per point, or numbers mapped through colorscale. Defaults to the colorway.

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

marker.colorscale colorscale ​

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

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

marker.autocolorscale boolean ​

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

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

marker.reversescale boolean ​

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

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

marker.cauto boolean ​

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

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

marker.cmin number ​

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

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

marker.cmax number ​

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

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

marker.cmid number ​

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

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

marker.showscale boolean ​

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

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

marker.colorbar ​

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

  • Type: object
  • Edit type: colorbars+layout

marker.colorbar.orientation enumerated ​

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

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

marker.colorbar.thicknessmode enumerated ​

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

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

marker.colorbar.thickness number ​

Thickness of the color bar.

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

marker.colorbar.lenmode enumerated ​

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

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

marker.colorbar.len number ​

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

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

marker.colorbar.x number ​

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

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

marker.colorbar.xref enumerated ​

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

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

marker.colorbar.xanchor enumerated ​

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

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

marker.colorbar.xpad number ​

Horizontal padding, px.

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

marker.colorbar.y number ​

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

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

marker.colorbar.yref enumerated ​

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

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

marker.colorbar.yanchor enumerated ​

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

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

marker.colorbar.ypad number ​

Vertical padding, px.

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

marker.colorbar.outlinecolor color ​

Color of the outline around the bar.

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

marker.colorbar.outlinewidth number ​

Outline width, px.

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

marker.colorbar.bordercolor color ​

Border color of the colorbar box.

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

marker.colorbar.borderwidth number ​

Border width of the box, px.

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

marker.colorbar.bgcolor color ​

Background of the box.

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

marker.colorbar.tickmode enumerated ​

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

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

marker.colorbar.nticks integer ​

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

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

marker.colorbar.tick0 any ​

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

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

marker.colorbar.dtick any ​

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

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

marker.colorbar.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

marker.colorbar.ticktext data_array ​

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

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

marker.colorbar.ticks enumerated ​

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

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

marker.colorbar.ticklen number ​

Tick length in px.

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

marker.colorbar.tickwidth number ​

Tick width in px.

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

marker.colorbar.tickcolor color ​

Tick color. Defaults to color.

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

marker.colorbar.ticklabelposition enumerated ​

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

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

marker.colorbar.ticklabeloverflow enumerated ​

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

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

marker.colorbar.ticklabelstep integer ​

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

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

marker.colorbar.showticklabels boolean ​

Show tick labels.

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

marker.colorbar.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: layout+plot

marker.colorbar.tickfont.family string ​

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

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

marker.colorbar.tickfont.size number ​

Font size in CSS pixels.

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

marker.colorbar.tickfont.color color ​

Text color.

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

marker.colorbar.tickfont.weight integer ​

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

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

marker.colorbar.tickfont.style enumerated ​

Font style.

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

marker.colorbar.tickfont.variant enumerated ​

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

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

marker.colorbar.tickfont.textcase enumerated ​

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

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

marker.colorbar.tickfont.lineposition flaglist ​

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

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

marker.colorbar.tickfont.shadow string ​

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

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

marker.colorbar.tickangle angle ​

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

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

marker.colorbar.tickformat string ​

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

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

marker.colorbar.tickprefix string ​

Text before each tick label.

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

marker.colorbar.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

marker.colorbar.ticksuffix string ​

Text after each tick label.

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

marker.colorbar.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

marker.colorbar.separatethousands boolean ​

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

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

marker.colorbar.exponentformat enumerated ​

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

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

marker.colorbar.minexponent number ​

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

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

marker.colorbar.showexponent enumerated ​

Which tick labels show the exponent.

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

marker.colorbar.title ​

Colorbar title.

  • Type: object
  • Edit type: colorbars+layout

marker.colorbar.title.text string ​

Colorbar title.

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

marker.colorbar.title.font ​

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

  • Type: object
  • Edit type: layout+plot

marker.colorbar.title.font.family string ​

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

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

marker.colorbar.title.font.size number ​

Font size in CSS pixels.

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

marker.colorbar.title.font.color color ​

Text color.

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

marker.colorbar.title.font.weight integer ​

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

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

marker.colorbar.title.font.style enumerated ​

Font style.

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

marker.colorbar.title.font.variant enumerated ​

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

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

marker.colorbar.title.font.textcase enumerated ​

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

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

marker.colorbar.title.font.lineposition flaglist ​

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

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

marker.colorbar.title.font.shadow string ​

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

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

marker.colorbar.title.side enumerated ​

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

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

marker.coloraxis subplotid ​

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

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

marker.size number ​

Marker diameter in CSS px, or one value per point (scaled by sizeref/sizemode).

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

marker.sizemode enumerated ​

How per-point size values become px: proportional to the diameter or to the area (bubble charts).

  • Type: enumerated
  • Values: "diameter" | "area"
  • Default: "diameter"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

marker.sizeref number ​

Divides per-point size values (bubble charts; see sizemode).

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

marker.sizemin number ​

Minimum radius (px) of markers with per-point size values.

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

marker.symbol enumerated ​

Marker symbol (Plotly's 3D set), or one per point.

  • Type: enumerated
  • Values: "circle" | "circle-open" | "cross" | "diamond" | "diamond-open" | "square" | "square-open" | "x"
  • Default: "circle"
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.opacity number ​

Marker opacity. Translucent markers are sorted back to front as the camera moves.

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

marker.line ​

Marker outline.

  • Type: object
  • Edit type: style

marker.line.color color ​

Marker outline color, one per point, or numbers mapped through its colorscale.

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

marker.line.colorscale colorscale ​

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

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

marker.line.autocolorscale boolean ​

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

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

marker.line.reversescale boolean ​

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

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

marker.line.cauto boolean ​

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

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

marker.line.cmin number ​

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

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

marker.line.cmax number ​

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

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

marker.line.cmid number ​

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

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

marker.line.coloraxis subplotid ​

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

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

marker.line.width number ​

Width of the marker outline in CSS px.

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

marker.render enumerated ​

How markers are drawn (a Holochart extension): 'sprite' — flat symbols facing the camera, Plotly's look; 'sphere' — lit, shaded spheres of the same size (every symbol draws as a sphere).

  • Type: enumerated
  • Values: "sprite" | "sphere"
  • Default: "sprite"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

surfaceaxis enumerated ​

Fill a surface through the points, triangulated (Delaunay) in the plane perpendicular to this axis (0: x, 1: y, 2: z); -1 for none.

  • Type: enumerated
  • Values: -1 | 0 | 1 | 2
  • Default: -1
  • Array OK: no
  • Edit type: calc
  • Animatable: no

surfacecolor color ​

Color of the surfaceaxis surface. Defaults to the line or marker color.

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

projection ​

Shadows of the markers on the scene's walls.

  • Type: object
  • Edit type: plot

projection.x ​

Shadow of the markers on the wall perpendicular to the x axis.

  • Type: object
  • Edit type: plot

projection.x.show boolean ​

Draw the points' shadow on the wall perpendicular to the x axis (the far wall, behind the data).

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

projection.x.opacity number ​

Opacity of the shadow markers (times the markers own opacity).

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

projection.x.scale number ​

Size of the shadow markers relative to the markers.

  • Type: number from 0 to 10
  • Default: 0.6666666666666666
  • Array OK: no
  • Edit type: style
  • Animatable: no

projection.y ​

Shadow of the markers on the wall perpendicular to the y axis.

  • Type: object
  • Edit type: plot

projection.y.show boolean ​

Draw the points' shadow on the wall perpendicular to the y axis (the far wall, behind the data).

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

projection.y.opacity number ​

Opacity of the shadow markers (times the markers own opacity).

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

projection.y.scale number ​

Size of the shadow markers relative to the markers.

  • Type: number from 0 to 10
  • Default: 0.6666666666666666
  • Array OK: no
  • Edit type: style
  • Animatable: no

projection.z ​

Shadow of the markers on the wall perpendicular to the z axis.

  • Type: object
  • Edit type: plot

projection.z.show boolean ​

Draw the points' shadow on the wall perpendicular to the z axis (the far wall, behind the data).

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

projection.z.opacity number ​

Opacity of the shadow markers (times the markers own opacity).

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

projection.z.scale number ​

Size of the shadow markers relative to the markers.

  • Type: number from 0 to 10
  • Default: 0.6666666666666666
  • Array OK: no
  • Edit type: style
  • Animatable: no

error_x ​

Error bars along the x axis, drawn as 3D segments through the points.

  • Type: object
  • Edit type: calc

error_x.visible boolean ​

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

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

error_x.type enumerated ​

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

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

error_x.symmetric boolean ​

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

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

error_x.array data_array ​

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

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

error_x.arrayminus data_array ​

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

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

error_x.value number ​

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

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

error_x.valueminus number ​

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

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

error_x.traceref integer ​

Accepted for Plotly compatibility; has no effect.

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

error_x.tracerefminus integer ​

Accepted for Plotly compatibility; has no effect.

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

error_x.thickness number ​

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

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

error_x.width number ​

Accepted for Plotly compatibility: 3D error bars are drawn without caps (Plotly draws them with a width of 0 by default).

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

error_x.color color ​

Color of the bars. Defaults to the trace color.

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

error_x.copy_zstyle boolean ​

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

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

error_y ​

Error bars along the y axis, drawn as 3D segments through the points.

  • Type: object
  • Edit type: calc

error_y.visible boolean ​

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

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

error_y.type enumerated ​

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

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

error_y.symmetric boolean ​

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

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

error_y.array data_array ​

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

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

error_y.arrayminus data_array ​

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

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

error_y.value number ​

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

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

error_y.valueminus number ​

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

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

error_y.traceref integer ​

Accepted for Plotly compatibility; has no effect.

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

error_y.tracerefminus integer ​

Accepted for Plotly compatibility; has no effect.

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

error_y.thickness number ​

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

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

error_y.width number ​

Accepted for Plotly compatibility: 3D error bars are drawn without caps (Plotly draws them with a width of 0 by default).

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

error_y.color color ​

Color of the bars. Defaults to the trace color.

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

error_y.copy_zstyle boolean ​

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

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

error_z ​

Error bars along the z axis, drawn as 3D segments through the points.

  • Type: object
  • Edit type: calc

error_z.visible boolean ​

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

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

error_z.type enumerated ​

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

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

error_z.symmetric boolean ​

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

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

error_z.array data_array ​

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

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

error_z.arrayminus data_array ​

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

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

error_z.value number ​

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

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

error_z.valueminus number ​

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

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

error_z.traceref integer ​

Accepted for Plotly compatibility; has no effect.

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

error_z.tracerefminus integer ​

Accepted for Plotly compatibility; has no effect.

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

error_z.thickness number ​

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

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

error_z.width number ​

Accepted for Plotly compatibility: 3D error bars are drawn without caps (Plotly draws them with a width of 0 by default).

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

error_z.color color ​

Color of the bars. Defaults to the trace color.

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

Released under the MIT License.