Skip to content

indicator attributes ​

A single value as a big number, its delta to a reference and / or an angular or bullet gauge with steps and a threshold, placed by domain; the gauge is one instanced GPU arc or rect set and the text one SDF batch.

  • Categories: domain, noOpacity, noHover
  • Plotly equivalent: indicator
  • Guide: indicator chart page
  • Used in examples: demos/dallas-weather/this-year, demos/index-funds/dashboard, demos/science-basics/thermometer, demos/tqqq-soxl/dashboard, indicator/bullet, indicator/count-up, indicator/dashboard, indicator/delta, indicator/gauge, indicator/interaction, indicator/number, indicator/styled

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

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

mode flaglist ​

What shows the value: number (the value as text), delta (its difference to delta.reference as text) and / or gauge (the value on an angular or bullet gauge).

  • Type: flaglist
  • Flags: "number", "delta", "gauge" (combine with +)
  • Default: "number"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

value number ​

The value to show. Transitions (layout.transition, animate) count the number up and move the gauge bar.

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

align enumerated ​

Horizontal alignment of the number and delta in the domain. No effect with an angular gauge, where they are always centered. Default center.

  • Type: enumerated
  • Values: "left" | "center" | "right"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title ​

The indicator title.

  • Type: object
  • Edit type: plot

title.text string ​

Title of the indicator (Plotly pseudo-HTML allowed).

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

title.align enumerated ​

Horizontal alignment of the title in the domain. Default center; a bullet gauge puts its title to the left of the domain, right-aligned.

  • Type: enumerated
  • Values: "left" | "center" | "right"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title.font ​

Title font. Defaults to layout.font at a quarter of the number font size.

  • Type: object
  • Edit type: plot

title.font.family string ​

CSS font-family list.

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

title.font.size number ​

Font size in CSS px.

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

title.font.color color ​

Text color.

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

title.font.weight integer ​

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

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

title.font.style enumerated ​

Font style.

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

number ​

The number (mode with number).

  • Type: object
  • Edit type: plot

number.valueformat string ​

d3-format specifier of the number. Default: rounded like a tick label of an axis from 0 to 1.5 times the value (or the gauge axis).

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

number.font ​

Font of the number. Defaults to layout.font; without a size, the number (and the delta) scale to fit the domain.

  • Type: object
  • Edit type: plot

number.font.family string ​

CSS font-family list.

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

number.font.size number ​

Font size in CSS px.

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

number.font.color color ​

Text color.

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

number.font.weight integer ​

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

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

number.font.style enumerated ​

Font style.

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

number.prefix string ​

Text before the number.

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

number.suffix string ​

Text after the number.

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

delta ​

The delta (mode with delta).

  • Type: object
  • Edit type: calc

delta.reference number ​

The reference the delta is computed from. Default: value.

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

delta.position enumerated ​

Where the delta goes relative to the number.

  • Type: enumerated
  • Values: "top" | "bottom" | "left" | "right"
  • Default: "bottom"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

delta.relative boolean ​

Show the relative change (value − reference) / reference.

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

delta.valueformat string ​

d3-format specifier of the delta. Default '2%' (a percentage, trailing zeros trimmed) when relative, else rounded like the number.

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

delta.increasing ​

Style of a positive delta.

  • Type: object
  • Edit type: plot

delta.increasing.symbol string ​

Symbol before a positive delta.

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

delta.increasing.color color ​

Color of a positive (or zero) delta.

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

delta.decreasing ​

Style of a negative delta.

  • Type: object
  • Edit type: plot

delta.decreasing.symbol string ​

Symbol before a negative delta.

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

delta.decreasing.color color ​

Color of a negative delta.

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

delta.font ​

Font of the delta. Defaults to layout.font, at half the number font size (or the number font size without a number).

  • Type: object
  • Edit type: plot

delta.font.family string ​

CSS font-family list.

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

delta.font.size number ​

Font size in CSS px.

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

delta.font.color color ​

Text color.

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

delta.font.weight integer ​

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

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

delta.font.style enumerated ​

Font style.

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

delta.prefix string ​

Text between the symbol and the delta.

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

delta.suffix string ​

Text after the delta.

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

gauge ​

The gauge (mode with gauge).

  • Type: object
  • Edit type: plot

gauge.shape enumerated ​

Gauge shape: angular (a half ring with the number in its middle) or bullet (a horizontal bar, the number to its right).

  • Type: enumerated
  • Values: "angular" | "bullet"
  • Default: "angular"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

gauge.bar ​

The bar from the start of the axis to the value. Default thickness 0.5 (0.25 on a bullet gauge) of the gauge's.

  • Type: object
  • Edit type: calc

gauge.bar.color color ​

Fill color of the value bar.

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

gauge.bar.line ​

Outline of the value bar.

  • Type: object
  • Edit type: plot

gauge.bar.line.color color ​

Outline color of the value bar.

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

gauge.bar.line.width number ​

Outline width of the value bar in CSS px (centered on its edge).

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

gauge.bar.thickness number ​

Thickness of the value bar as a fraction of the gauge's thickness, centered on it.

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

gauge.bgcolor color ​

Gauge background color. Default: layout.paper_bgcolor.

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

gauge.bordercolor color ​

Color of the gauge outline.

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

gauge.borderwidth number ​

Width of the gauge outline in CSS px.

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

gauge.axis ​

The gauge axis: its range, ticks and tick labels.

  • Type: object
  • Edit type: plot

gauge.axis.range info_array ​

Values at the start and end of the gauge; a null end keeps its default. Default [0, 1.5 × value].

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

gauge.axis.visible boolean ​

Show the axis ticks and tick labels.

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

gauge.axis.tickmode enumerated ​

auto picks up to nticks round ticks; linear places ticks from tick0 every dtick; array uses tickvals/ticktext. Defaults to array when tickvals is set, linear when dtick is set, else auto.

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

gauge.axis.nticks integer ​

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

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

gauge.axis.tick0 any ​

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

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

gauge.axis.dtick any ​

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

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

gauge.axis.tickvals data_array ​

Tick positions for tickmode: array (data units).

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

gauge.axis.ticktext data_array ​

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

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

gauge.axis.ticklen number ​

Tick length in px.

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

gauge.axis.tickwidth number ​

Tick width in px.

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

gauge.axis.ticklabelstep integer ​

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

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

gauge.axis.showticklabels boolean ​

Show tick labels.

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

gauge.axis.tickangle angle ​

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

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

gauge.axis.tickformat string ​

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

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

gauge.axis.tickformatstops ​

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

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

gauge.axis.tickformatstops[].enabled boolean ​

Whether this stop is used.

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

gauge.axis.tickformatstops[].visible boolean ​

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

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

gauge.axis.tickformatstops[].dtickrange info_array ​

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

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

gauge.axis.tickformatstops[].value string ​

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

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

gauge.axis.tickformatstops[].name string ​

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

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

gauge.axis.tickformatstops[].templateitemname string ​

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

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

gauge.axis.tickprefix string ​

Text before each tick label.

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

gauge.axis.showtickprefix enumerated ​

Which tick labels get tickprefix.

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

gauge.axis.ticksuffix string ​

Text after each tick label.

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

gauge.axis.showticksuffix enumerated ​

Which tick labels get ticksuffix.

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

gauge.axis.separatethousands boolean ​

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

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

gauge.axis.exponentformat enumerated ​

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

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

gauge.axis.minexponent number ​

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

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

gauge.axis.showexponent enumerated ​

Which tick labels show the exponent.

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

gauge.axis.ticks enumerated ​

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

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

gauge.axis.tickcolor color ​

Tick color.

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

gauge.axis.tickfont ​

Tick-label font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

gauge.axis.tickfont.family string ​

CSS font-family list.

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

gauge.axis.tickfont.size number ​

Font size in CSS px.

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

gauge.axis.tickfont.color color ​

Text color.

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

gauge.axis.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

gauge.axis.tickfont.style enumerated ​

Font style.

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

gauge.steps ​

Colored bands of the gauge (ranges such as "good" / "bad"), drawn under the value bar.

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

gauge.steps[].color color ​

Fill color of the step.

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

gauge.steps[].line ​

Outline of the step.

  • Type: object
  • Edit type: plot

gauge.steps[].line.color color ​

Outline color of the step.

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

gauge.steps[].line.width number ​

Outline width of the step in CSS px (centered on its edge).

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

gauge.steps[].thickness number ​

Thickness of the step as a fraction of the gauge's thickness, centered on it.

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

gauge.steps[].range info_array ​

Axis values the step spans.

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

gauge.steps[].name string ​

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

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

gauge.steps[].templateitemname string ​

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

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

gauge.threshold ​

A line marking a threshold value on the gauge.

  • Type: object
  • Edit type: plot

gauge.threshold.line ​

The threshold line.

  • Type: object
  • Edit type: plot

gauge.threshold.line.color color ​

Color of the threshold line.

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

gauge.threshold.line.width number ​

Width of the threshold line in CSS px.

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

gauge.threshold.thickness number ​

Length of the threshold line as a fraction of the gauge's thickness, centered on it.

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

gauge.threshold.value number ​

Axis value marked by a line across the gauge. Unset: no line.

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

Released under the MIT License.