Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at contact@anvil.works.

plotly.graph_objs.indicator.gauge Module

Functions

plotly.graph_objs.indicator.gauge.Axis([range=], [visible=], [tickmode=], [nticks=], [tick0=], [dtick=], [tickvals=], [ticktext=], [ticks=], [ticklen=], [tickwidth=], [tickcolor=], [showticklabels=], [tickfont=], [tickangle=], [tickformat=], [tickformatstop=], [tickprefix=], [showtickprefix=], [ticksuffix=], [showticksuffix=], [separatethousands=], [exponentformat=], [minexponent=], [showexponent=], [tickvalssrc=], [ticktextsrc=]) → Axis

Create a new ‘Axis’ object

  • range - Sets the range of this axis.

  • visible - A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false

  • tickmode - Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).

  • nticks - Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.

  • tick0 - Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

  • dtick - Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*

  • tickvals - Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.

  • ticktext - Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.

  • ticks - Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.

  • ticklen - Sets the tick length (in px).

  • tickwidth - Sets the tick width (in px).

  • tickcolor - Sets the tick color.

  • showticklabels - Determines whether or not the tick labels are drawn.

  • tickfont - Sets the color bar's tick label font

  • tickangle - Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

  • tickformat - Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*

  • tickprefix - Sets a tick label prefix.

  • showtickprefix - If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.

  • ticksuffix - Sets a tick label suffix.

  • showticksuffix - Same as `showtickprefix` but for tick suffixes.

  • separatethousands - If "true", even 4-digit integers are separated

  • exponentformat - Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.

  • minexponent - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

  • showexponent - If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.

  • tickvalssrc - Sets the source reference on Chart Studio Cloud for tickvals .

  • ticktextsrc - Sets the source reference on Chart Studio Cloud for ticktext .


plotly.graph_objs.indicator.gauge.Bar([color=], [line=], [thickness=]) → Bar

Create a new ‘Bar’ object

  • color - Sets the background color of the arc.

  • thickness - Sets the thickness of the bar as a fraction of the total thickness of the gauge.


plotly.graph_objs.indicator.gauge.Step([color=], [line=], [thickness=], [range=], [name=], [templateitemname=]) → Step

Create a new ‘Step’ object

  • color - Sets the background color of the arc.

  • thickness - Sets the thickness of the bar as a fraction of the total thickness of the gauge.

  • range - Sets the range of this axis.

  • name - When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

  • templateitemname - Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.


plotly.graph_objs.indicator.gauge.Threshold([line=], [thickness=], [value=]) → Threshold

Create a new ‘Threshold’ object

  • thickness - Sets the thickness of the threshold line as a fraction of the thickness of the gauge.

  • value - Sets a treshold value drawn as a line.


Globals






plotly.graph_objs.indicator.gauge