Skip to content

parcats attributes ​

Parallel categories: category bands per dimension sized by count, with paths across them for each combination; hover for counts and probabilities, drag to reorder categories and dimensions.

  • Categories: domain, noOpacity
  • Plotly equivalent: parcats
  • Guide: parcats chart page
  • Used in examples: demos/dallas-weather/day-types, demos/index-funds/days-parcats, demos/science-basics/element-flow, demos/tqqq-soxl/co-movement, parcats/basic, parcats/colored, parcats/counts, parcats/freeform, parcats/hspline, parcats/interaction

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

Fields of the hover labels; 'none' keeps the highlighting without labels, 'skip' turns hover off.

  • Type: flaglist
  • Flags: "count", "probability" (combine with +)
  • Also accepts: "all" | "none" | "skip"
  • Default: "all"
  • Array OK: no
  • 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

domain ​

Where this trace is drawn, as a part of the plot area.

  • Type: object
  • Edit type: plot

domain.x info_array ​

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

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

domain.y info_array ​

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

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

domain.row integer ​

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

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

domain.column integer ​

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

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

dimensions ​

The dimensions, left to right: each sample is a path across them.

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

dimensions[].label string ​

Dimension title, drawn above it.

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

dimensions[].values data_array ​

The category of each sample in this dimension. A dimension without values is hidden.

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

dimensions[].categoryorder enumerated ​

Order of the categories, top to bottom: first appearance ('trace'), sorted, or categoryarray (then unlisted values by appearance). Default: 'array' when categoryarray is given, else 'trace'. Dragging a category restyles it to 'array'.

  • Type: enumerated
  • Values: "trace" | "category ascending" | "category descending" | "array"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

dimensions[].categoryarray data_array ​

The category order with categoryorder: 'array'.

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

dimensions[].ticktext data_array ​

Category labels, one per categoryarray entry (categoryorder: 'array' only). Default: the values.

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

dimensions[].displayindex integer ​

Position of this dimension, left to right. Default: its index. Used only when the visible dimensions form a permutation of 0 … n − 1; dragging a dimension restyles it.

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

dimensions[].visible boolean ​

Show this dimension. Hidden dimensions keep their place in dimensions.

  • Type: boolean
  • Default: true
  • 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

counts number ​

Weight of each sample (one for all, or one per sample; arrays repeat).

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

line ​

The paths, one per distinct combination and color.

  • Type: object
  • Edit type: calc

line.color color ​

Path color: one CSS color, or one number per sample mapped through line.colorscale (samples of different colors form separate paths). Default: the trace color.

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

line.colorscale colorscale ​

Colorscale for numeric line.color values (one per sample): 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 (layout.colorscale.sequential, sequentialminus or diverging) instead of colorscale.

  • 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 the line colorscale.

  • 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.shape enumerated ​

Path shape between dimensions: straight or a horizontal S-curve.

  • Type: enumerated
  • Values: "linear" | "hspline"
  • Default: "linear"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

line.hovertemplate string ​

Template of the path hover labels: %{count}, %{probability}. Overrides hoverinfo for paths.

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

arrangement enumerated ​

Dragging: categories move vertically and dimensions horizontally ('perpendicular'), categories move freely ('freeform'), or nothing moves ('fixed').

  • Type: enumerated
  • Values: "perpendicular" | "freeform" | "fixed"
  • Default: "perpendicular"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

bundlecolors boolean ​

Group paths of the same color together within each category.

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

sortpaths enumerated ​

Stack paths by their categories from the leftmost dimension (forward) or the rightmost (backward).

  • Type: enumerated
  • Values: "forward" | "backward"
  • Default: "forward"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

hoveron enumerated ​

What a hover over a category band shows: the category, the colored band under the pointer ('color'), or every category of the dimension.

  • Type: enumerated
  • Values: "category" | "color" | "dimension"
  • Default: "category"
  • Array OK: no
  • Edit type: none
  • Animatable: no

labelfont ​

Font of the dimension labels. Default: layout.font.

  • Type: object
  • Edit type: plot

labelfont.family string ​

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

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

labelfont.size number ​

Font size in CSS px.

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

labelfont.color color ​

Text color. Default: layout.font.color.

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

labelfont.weight integer ​

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

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

labelfont.style enumerated ​

Font style.

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

labelfont.shadow string ​

CSS text-shadow (first shadow only), 'none', or 'auto': a thin halo in the text's contrast color. Tick labels default to 'auto', so they read over the lines.

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

tickfont ​

Font of the category labels. Default: layout.font, 1/1.2 the size.

  • Type: object
  • Edit type: plot

tickfont.family string ​

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

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

tickfont.size number ​

Font size in CSS px.

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

tickfont.color color ​

Text color. Default: layout.font.color.

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

tickfont.weight integer ​

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

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

tickfont.style enumerated ​

Font style.

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

tickfont.shadow string ​

CSS text-shadow (first shadow only), 'none', or 'auto': a thin halo in the text's contrast color. Tick labels default to 'auto', so they read over the lines.

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

Released under the MIT License.