Skip to content

splom attributes ​

Scatter plot matrix: every pair of dimensions as a scatter plot in a grid of subplots, with linked box / lasso selection across cells; each dimension is uploaded to the GPU once and shared by every cell.

  • Categories: symbols, showLegend
  • Plotly equivalent: splom
  • Guide: splom chart page
  • Used in examples: demos/dallas-weather/years-splom, demos/index-funds/splom, demos/science-basics/element-splom, demos/tqqq-soxl/splom, splom/axis-types, splom/colorscale, splom/dense, splom/interaction, splom/iris, splom/large, splom/lower-half

Generated from the attribute schema (159 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

dimensions ​

The dimensions of the matrix: one row and one column per dimension, in order (row 0 on top).

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

dimensions[].visible boolean ​

Whether the dimension is drawn. A hidden dimension keeps its row and column, empty. Forced to false without values.

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

dimensions[].label string ​

Label of the dimension: the default title of its axes and the name hover labels give its values.

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

dimensions[].values data_array ​

Values of the dimension, one per sample (numbers, dates or categories; typed arrays are used as they are). Every dimension indexes the same samples; the shortest one sets the sample count.

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

dimensions[].axis ​

Defaults for the dimension's axes.

  • Type: object
  • Edit type: calc

dimensions[].axis.type enumerated ​

Default type of the dimension's axes. Without it the type is detected from values.

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

dimensions[].axis.matches boolean ​

Link the dimension's x and y axes (matches), so zooming one zooms the other.

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

dimensions[].name string ​

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

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

dimensions[].templateitemname string ​

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

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

text string ​

Text per sample, shown in hover labels.

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

diagonal ​

The diagonal cells.

  • Type: object
  • Edit type: calc

diagonal.visible boolean ​

Whether the diagonal cells (each dimension against itself: the samples on a line) are drawn.

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

showupperhalf boolean ​

Whether the cells above the diagonal are drawn.

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

showlowerhalf boolean ​

Whether the cells below the diagonal are drawn.

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

xaxes info_array ​

The x axis of each dimension, in order ('x', 'x2', …). Default ['x', 'x2', …], one per dimension. Dimension i is drawn along the column of this axis.

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

yaxes info_array ​

The y axis of each dimension, in order ('y', 'y2', …). Default ['y', 'y2', …], one per dimension. Dimension i is drawn along the row of this axis.

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

marker ​

Marker style, the same in every cell: color (per sample, or numbers mapped through colorscale with an optional colorbar), size, symbol, opacity, angle and outline.

  • Type: object
  • Edit type: calc

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: 6
  • 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: a name ('diamond-open'), a Plotly numeric code, a custom symbol registered with symbols.register (with the same -open / -dot variants), a 'text:…' glyph such as 'text:🚀', or one per point.

  • Type: enumerated
  • Values: "circle" | 0 | "0" | "circle-open" | 100 | "100" | "circle-dot" | 200 | "200" | "circle-open-dot" | 300 | "300" | "square" | 1 | "1" | "square-open" | 101 | "101" | "square-dot" | 201 | "201" | "square-open-dot" | 301 | "301" | "diamond" | 2 | "2" | "diamond-open" | 102 | "102" | "diamond-dot" | 202 | "202" | "diamond-open-dot" | 302 | "302" | "cross" | 3 | "3" | "cross-open" | 103 | "103" | "cross-dot" | 203 | "203" | "cross-open-dot" | 303 | "303" | "x" | 4 | "4" | "x-open" | 104 | "104" | "x-dot" | 204 | "204" | "x-open-dot" | 304 | "304" | "triangle-up" | 5 | "5" | "triangle-up-open" | 105 | "105" | "triangle-up-dot" | 205 | "205" | "triangle-up-open-dot" | 305 | "305" | "triangle-down" | 6 | "6" | "triangle-down-open" | 106 | "106" | "triangle-down-dot" | 206 | "206" | "triangle-down-open-dot" | 306 | "306" | "triangle-left" | 7 | "7" | "triangle-left-open" | 107 | "107" | "triangle-left-dot" | 207 | "207" | "triangle-left-open-dot" | 307 | "307" | "triangle-right" | 8 | "8" | "triangle-right-open" | 108 | "108" | "triangle-right-dot" | 208 | "208" | "triangle-right-open-dot" | 308 | "308" | "triangle-ne" | 9 | "9" | "triangle-ne-open" | 109 | "109" | "triangle-ne-dot" | 209 | "209" | "triangle-ne-open-dot" | 309 | "309" | "triangle-se" | 10 | "10" | "triangle-se-open" | 110 | "110" | "triangle-se-dot" | 210 | "210" | "triangle-se-open-dot" | 310 | "310" | "triangle-sw" | 11 | "11" | "triangle-sw-open" | 111 | "111" | "triangle-sw-dot" | 211 | "211" | "triangle-sw-open-dot" | 311 | "311" | "triangle-nw" | 12 | "12" | "triangle-nw-open" | 112 | "112" | "triangle-nw-dot" | 212 | "212" | "triangle-nw-open-dot" | 312 | "312" | "pentagon" | 13 | "13" | "pentagon-open" | 113 | "113" | "pentagon-dot" | 213 | "213" | "pentagon-open-dot" | 313 | "313" | "hexagon" | 14 | "14" | "hexagon-open" | 114 | "114" | "hexagon-dot" | 214 | "214" | "hexagon-open-dot" | 314 | "314" | "hexagon2" | 15 | "15" | "hexagon2-open" | 115 | "115" | "hexagon2-dot" | 215 | "215" | "hexagon2-open-dot" | 315 | "315" | "octagon" | 16 | "16" | "octagon-open" | 116 | "116" | "octagon-dot" | 216 | "216" | "octagon-open-dot" | 316 | "316" | "star" | 17 | "17" | "star-open" | 117 | "117" | "star-dot" | 217 | "217" | "star-open-dot" | 317 | "317" | "hexagram" | 18 | "18" | "hexagram-open" | 118 | "118" | "hexagram-dot" | 218 | "218" | "hexagram-open-dot" | 318 | "318" | "star-triangle-up" | 19 | "19" | "star-triangle-up-open" | 119 | "119" | "star-triangle-up-dot" | 219 | "219" | "star-triangle-up-open-dot" | 319 | "319" | "star-triangle-down" | 20 | "20" | "star-triangle-down-open" | 120 | "120" | "star-triangle-down-dot" | 220 | "220" | "star-triangle-down-open-dot" | 320 | "320" | "star-square" | 21 | "21" | "star-square-open" | 121 | "121" | "star-square-dot" | 221 | "221" | "star-square-open-dot" | 321 | "321" | "star-diamond" | 22 | "22" | "star-diamond-open" | 122 | "122" | "star-diamond-dot" | 222 | "222" | "star-diamond-open-dot" | 322 | "322" | "diamond-tall" | 23 | "23" | "diamond-tall-open" | 123 | "123" | "diamond-tall-dot" | 223 | "223" | "diamond-tall-open-dot" | 323 | "323" | "diamond-wide" | 24 | "24" | "diamond-wide-open" | 124 | "124" | "diamond-wide-dot" | 224 | "224" | "diamond-wide-open-dot" | 324 | "324" | "hourglass" | 25 | "25" | "hourglass-open" | 125 | "125" | "hourglass-dot" | 225 | "225" | "hourglass-open-dot" | 325 | "325" | "bowtie" | 26 | "26" | "bowtie-open" | 126 | "126" | "bowtie-dot" | 226 | "226" | "bowtie-open-dot" | 326 | "326" | "circle-cross" | 27 | "27" | "circle-cross-open" | 127 | "127" | "circle-cross-dot" | 227 | "227" | "circle-cross-open-dot" | 327 | "327" | "circle-x" | 28 | "28" | "circle-x-open" | 128 | "128" | "circle-x-dot" | 228 | "228" | "circle-x-open-dot" | 328 | "328" | "square-cross" | 29 | "29" | "square-cross-open" | 129 | "129" | "square-cross-dot" | 229 | "229" | "square-cross-open-dot" | 329 | "329" | "square-x" | 30 | "30" | "square-x-open" | 130 | "130" | "square-x-dot" | 230 | "230" | "square-x-open-dot" | 330 | "330" | "diamond-cross" | 31 | "31" | "diamond-cross-open" | 131 | "131" | "diamond-cross-dot" | 231 | "231" | "diamond-cross-open-dot" | 331 | "331" | "diamond-x" | 32 | "32" | "diamond-x-open" | 132 | "132" | "diamond-x-dot" | 232 | "232" | "diamond-x-open-dot" | 332 | "332" | "cross-thin" | 33 | "33" | "cross-thin-open" | 133 | "133" | "cross-thin-dot" | 233 | "233" | "cross-thin-open-dot" | 333 | "333" | "x-thin" | 34 | "34" | "x-thin-open" | 134 | "134" | "x-thin-dot" | 234 | "234" | "x-thin-open-dot" | 334 | "334" | "asterisk" | 35 | "35" | "asterisk-open" | 135 | "135" | "asterisk-dot" | 235 | "235" | "asterisk-open-dot" | 335 | "335" | "hash" | 36 | "36" | "hash-open" | 136 | "136" | "hash-dot" | 236 | "236" | "hash-open-dot" | 336 | "336" | "y-up" | 37 | "37" | "y-up-open" | 137 | "137" | "y-up-dot" | 237 | "237" | "y-up-open-dot" | 337 | "337" | "y-down" | 38 | "38" | "y-down-open" | 138 | "138" | "y-down-dot" | 238 | "238" | "y-down-open-dot" | 338 | "338" | "y-left" | 39 | "39" | "y-left-open" | 139 | "139" | "y-left-dot" | 239 | "239" | "y-left-open-dot" | 339 | "339" | "y-right" | 40 | "40" | "y-right-open" | 140 | "140" | "y-right-dot" | 240 | "240" | "y-right-open-dot" | 340 | "340" | "line-ew" | 41 | "41" | "line-ew-open" | 141 | "141" | "line-ew-dot" | 241 | "241" | "line-ew-open-dot" | 341 | "341" | "line-ns" | 42 | "42" | "line-ns-open" | 142 | "142" | "line-ns-dot" | 242 | "242" | "line-ns-open-dot" | 342 | "342" | "line-ne" | 43 | "43" | "line-ne-open" | 143 | "143" | "line-ne-dot" | 243 | "243" | "line-ne-open-dot" | 343 | "343" | "line-nw" | 44 | "44" | "line-nw-open" | 144 | "144" | "line-nw-dot" | 244 | "244" | "line-nw-open-dot" | 344 | "344" | "arrow-up" | 45 | "45" | "arrow-up-open" | 145 | "145" | "arrow-up-dot" | 245 | "245" | "arrow-up-open-dot" | 345 | "345" | "arrow-down" | 46 | "46" | "arrow-down-open" | 146 | "146" | "arrow-down-dot" | 246 | "246" | "arrow-down-open-dot" | 346 | "346" | "arrow-left" | 47 | "47" | "arrow-left-open" | 147 | "147" | "arrow-left-dot" | 247 | "247" | "arrow-left-open-dot" | 347 | "347" | "arrow-right" | 48 | "48" | "arrow-right-open" | 148 | "148" | "arrow-right-dot" | 248 | "248" | "arrow-right-open-dot" | 348 | "348" | "arrow-bar-up" | 49 | "49" | "arrow-bar-up-open" | 149 | "149" | "arrow-bar-up-dot" | 249 | "249" | "arrow-bar-up-open-dot" | 349 | "349" | "arrow-bar-down" | 50 | "50" | "arrow-bar-down-open" | 150 | "150" | "arrow-bar-down-dot" | 250 | "250" | "arrow-bar-down-open-dot" | 350 | "350" | "arrow-bar-left" | 51 | "51" | "arrow-bar-left-open" | 151 | "151" | "arrow-bar-left-dot" | 251 | "251" | "arrow-bar-left-open-dot" | 351 | "351" | "arrow-bar-right" | 52 | "52" | "arrow-bar-right-open" | 152 | "152" | "arrow-bar-right-dot" | 252 | "252" | "arrow-bar-right-open-dot" | 352 | "352" | "arrow" | 53 | "53" | "arrow-open" | 153 | "153" | "arrow-dot" | 253 | "253" | "arrow-open-dot" | 353 | "353" | "arrow-wide" | 54 | "54" | "arrow-wide-open" | 154 | "154" | "arrow-wide-dot" | 254 | "254" | "arrow-wide-open-dot" | 354 | "354"
  • Default: "circle"
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.image string ​

Image sprites: a URL or data URI drawn instead of the symbol in a size × size square (keeping its aspect ratio), or one per point (empty entries keep the symbol). opacity applies; color and line do not. Cross-origin URLs need CORS headers.

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

marker.opacity number ​

Marker opacity (multiplied by the trace opacity), or one per point. Default 1, 0.7 for bubbles.

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

marker.angle angle ​

Marker rotation in degrees, clockwise, or one per point.

  • Type: angle (degrees)
  • Default: 0
  • Array OK: yes (one value per point)
  • 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 ​

Marker outline width in CSS px, or one per point. Default 0, 1 for bubbles.

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

selected ​

Style of selected points while a selection is active (box/lasso select in any cell, selectedpoints), in every cell.

  • Type: object
  • Edit type: style

selected.marker ​

Marker style of selected points.

  • Type: object
  • Edit type: style

selected.marker.opacity number ​

Marker opacity of selected points.

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

selected.marker.color color ​

Marker color of selected points.

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

selected.marker.size number ​

Marker size (px) of selected points.

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

unselected ​

Style of unselected points while a selection is active (box/lasso select in any cell, selectedpoints), in every cell.

  • Type: object
  • Edit type: style

unselected.marker ​

Marker style of unselected points.

  • Type: object
  • Edit type: style

unselected.marker.opacity number ​

Marker opacity of unselected points. Default: 0.2 × the marker opacity when no selected/unselected opacity is set.

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

unselected.marker.color color ​

Marker color of unselected points.

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

unselected.marker.size number ​

Marker size (px) of unselected points.

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

Released under the MIT License.