indicator
Traces
A
indicator
trace is an object with the key
"type"
equal to
"indicator"
(i.e.
{"type": "indicator"}
) and any of the keys listed below.
An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges.
data[type=indicator]
data[type=indicator]
Sets the trace name. The trace name appears as the legend item and on hover.
data[type=indicator]
data[type=indicator].title
"left"
| "center"
| "right"
)
Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.
data[type=indicator].title
Set the font used to display the title
data[type=indicator].title.font
data[type=indicator].title.font
HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
data[type=indicator].title.font
"under"
, "over"
, "through"
joined with a "+"
OR "none"
. "under"
, "over"
, "under+over"
, "under+over+through"
, "none"
"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
data[type=indicator].title.font
"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
data[type=indicator].title.font
data[type=indicator].title.font
"normal"
| "italic"
) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
data[type=indicator].title.font
"normal"
| "word caps"
| "upper"
| "lower"
) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
data[type=indicator].title.font
"normal"
| "small-caps"
| "all-small-caps"
| "all-petite-caps"
| "petite-caps"
| "unicase"
) "normal"
Sets the variant of the font.
data[type=indicator].title.font
normal
Sets the weight (or boldness) of the font.
data[type=indicator].title
Sets the title of this indicator.
data[type=indicator]
true
| false
| "legendonly"
) true
Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
data[type=indicator]
legend
Sets the reference to a legend to show this trace in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.
data[type=indicator]
1000
Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
data[type=indicator]
data[type=indicator].legendgrouptitle
Sets this legend group's title font.
data[type=indicator].legendgrouptitle.font
data[type=indicator].legendgrouptitle.font
HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
data[type=indicator].legendgrouptitle.font
"under"
, "over"
, "through"
joined with a "+"
OR "none"
. "under"
, "over"
, "under+over"
, "under+over+through"
, "none"
"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
data[type=indicator].legendgrouptitle.font
"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
data[type=indicator].legendgrouptitle.font
data[type=indicator].legendgrouptitle.font
"normal"
| "italic"
) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
data[type=indicator].legendgrouptitle.font
"normal"
| "word caps"
| "upper"
| "lower"
) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
data[type=indicator].legendgrouptitle.font
"normal"
| "small-caps"
| "all-small-caps"
| "all-petite-caps"
| "petite-caps"
| "unicase"
) "normal"
Sets the variant of the font.
data[type=indicator].legendgrouptitle.font
normal
Sets the weight (or boldness) of the font.
data[type=indicator].legendgrouptitle
""
Sets the title of the legend group.
data[type=indicator]
Sets the width (in px or fraction) of the legend for this trace.
data[type=indicator]
"number"
, "delta"
, "gauge"
joined with a "+"
"number"
, "delta"
, "number+delta"
, "number+delta+gauge"
"number"
Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.
data[type=indicator]
Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
data[type=indicator]
Sets the number to be displayed.
data[type=indicator]
Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
data[type=indicator]
Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
data[type=indicator]
data[type=indicator].domain
0
If there is a layout grid, use the domain for this column in the grid for this indicator trace .
data[type=indicator].domain
0
If there is a layout grid, use the domain for this row in the grid for this indicator trace .
data[type=indicator].domain
[0, 1]
Sets the horizontal domain of this indicator trace (in plot fraction).
data[type=indicator].domain
[0, 1]
Sets the vertical domain of this indicator trace (in plot fraction).
data[type=indicator]
"left"
| "center"
| "right"
)
Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered
data[type=indicator]
data[type=indicator].delta
data[type=indicator].delta
Set the font used to display the delta
data[type=indicator].delta.font
data[type=indicator].delta.font
HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
data[type=indicator].delta.font
"under"
, "over"
, "through"
joined with a "+"
OR "none"
. "under"
, "over"
, "under+over"
, "under+over+through"
, "none"
"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
data[type=indicator].delta.font
"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
data[type=indicator].delta.font
data[type=indicator].delta.font
"normal"
| "italic"
) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
data[type=indicator].delta.font
"normal"
| "word caps"
| "upper"
| "lower"
) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
data[type=indicator].delta.font
"normal"
| "small-caps"
| "all-small-caps"
| "all-petite-caps"
| "petite-caps"
| "unicase"
) "normal"
Sets the variant of the font.
data[type=indicator].delta.font
normal
Sets the weight (or boldness) of the font.
data[type=indicator].delta
data[type=indicator].delta
"top"
| "bottom"
| "left"
| "right"
) "bottom"
Sets the position of delta with respect to the number.
data[type=indicator].delta
""
Sets a prefix appearing before the delta.
data[type=indicator].delta
Sets the reference value to compute the delta. By default, it is set to the current value.
data[type=indicator].delta
Show relative change
data[type=indicator].delta
""
Sets a suffix appearing next to the delta.
data[type=indicator].delta
Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
data[type=indicator]
data[type=indicator].number
Set the font used to display main number
data[type=indicator].number.font
data[type=indicator].number.font
HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
data[type=indicator].number.font
"under"
, "over"
, "through"
joined with a "+"
OR "none"
. "under"
, "over"
, "under+over"
, "under+over+through"
, "none"
"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
data[type=indicator].number.font
"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
data[type=indicator].number.font
data[type=indicator].number.font
"normal"
| "italic"
) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
data[type=indicator].number.font
"normal"
| "word caps"
| "upper"
| "lower"
) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
data[type=indicator].number.font
"normal"
| "small-caps"
| "all-small-caps"
| "all-petite-caps"
| "petite-caps"
| "unicase"
) "normal"
Sets the variant of the font.
data[type=indicator].number.font
normal
Sets the weight (or boldness) of the font.
data[type=indicator].number
""
Sets a prefix appearing before the number.
data[type=indicator].number
""
Sets a suffix appearing next to the number.
data[type=indicator].number
""
Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
data[type=indicator]
The gauge of the Indicator plot.
data[type=indicator].gauge
data[type=indicator].gauge.axis
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"
data[type=indicator].gauge.axis
"none"
| "e"
| "E"
| "power"
| "SI"
| "B"
) "B"
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.
data[type=indicator].gauge.axis
Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
data[type=indicator].gauge.axis
3
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
data[type=indicator].gauge.axis
0
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".
data[type=indicator].gauge.axis
Sets the range of this axis.
data[type=indicator].gauge.axis
If "true", even 4-digit integers are separated
data[type=indicator].gauge.axis
"all"
| "first"
| "last"
| "none"
) "all"
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.
data[type=indicator].gauge.axis
true
Determines whether or not the tick labels are drawn.
data[type=indicator].gauge.axis
"all"
| "first"
| "last"
| "none"
) "all"
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.
data[type=indicator].gauge.axis
"all"
| "first"
| "last"
| "none"
) "all"
Same as `showtickprefix` but for tick suffixes.
data[type=indicator].gauge.axis
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.
data[type=indicator].gauge.axis
"auto"
Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
data[type=indicator].gauge.axis
"#444"
Sets the tick color.
data[type=indicator].gauge.axis
Sets the color bar's tick label font
data[type=indicator].gauge.axis.tickfont
data[type=indicator].gauge.axis.tickfont
HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.
data[type=indicator].gauge.axis.tickfont
"under"
, "over"
, "through"
joined with a "+"
OR "none"
. "under"
, "over"
, "under+over"
, "under+over+through"
, "none"
"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
data[type=indicator].gauge.axis.tickfont
"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
data[type=indicator].gauge.axis.tickfont
data[type=indicator].gauge.axis.tickfont
"normal"
| "italic"
) "normal"
Sets whether a font should be styled with a normal or italic face from its family.
data[type=indicator].gauge.axis.tickfont
"normal"
| "word caps"
| "upper"
| "lower"
) "normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
data[type=indicator].gauge.axis.tickfont
"normal"
| "small-caps"
| "all-small-caps"
| "all-petite-caps"
| "petite-caps"
| "unicase"
) "normal"
Sets the variant of the font.
data[type=indicator].gauge.axis.tickfont
normal
Sets the weight (or boldness) of the font.
data[type=indicator].gauge.axis
""
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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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"
data[type=indicator].gauge.axis
data[type=indicator].gauge.axis.tickformatstops[]
range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
data[type=indicator].gauge.axis.tickformatstops[]
true
Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
data[type=indicator].gauge.axis.tickformatstops[]
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.
data[type=indicator].gauge.axis.tickformatstops[]
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`.
data[type=indicator].gauge.axis.tickformatstops[]
""
string - dtickformat for described zoom level, the same as "tickformat"
data[type=indicator].gauge.axis
1
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
data[type=indicator].gauge.axis
5
Sets the tick length (in px).
data[type=indicator].gauge.axis
"auto"
| "linear"
| "array"
)
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).
data[type=indicator].gauge.axis
""
Sets a tick label prefix.
data[type=indicator].gauge.axis
"outside"
| "inside"
| ""
) "outside"
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.
data[type=indicator].gauge.axis
""
Sets a tick label suffix.
data[type=indicator].gauge.axis
Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
data[type=indicator].gauge.axis
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
data[type=indicator].gauge.axis
1
Sets the tick width (in px).
data[type=indicator].gauge.axis
true
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
data[type=indicator].gauge
Set the appearance of the gauge's value
data[type=indicator].gauge.bar
"green"
Sets the background color of the arc.
data[type=indicator].gauge.bar
data[type=indicator].gauge.bar
1
Sets the thickness of the bar as a fraction of the total thickness of the gauge.
data[type=indicator].gauge
Sets the gauge background color.
data[type=indicator].gauge
"#444"
Sets the color of the border enclosing the gauge.
data[type=indicator].gauge
1
Sets the width (in px) of the border enclosing the gauge.
data[type=indicator].gauge
"angular"
| "bullet"
) "angular"
Set the shape of the gauge
data[type=indicator].gauge
data[type=indicator].gauge.steps[]
Sets the background color of the arc.
data[type=indicator].gauge.steps[]
data[type=indicator].gauge.steps[]
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.
data[type=indicator].gauge.steps[]
Sets the range of this axis.
data[type=indicator].gauge.steps[]
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`.
data[type=indicator].gauge.steps[]
1
Sets the thickness of the bar as a fraction of the total thickness of the gauge.
data[type=indicator].gauge
data[type=indicator].gauge.threshold
data[type=indicator].gauge.threshold
0.85
Sets the thickness of the threshold line as a fraction of the thickness of the gauge.
data[type=indicator].gauge.threshold
Sets a treshold value drawn as a line.
data[type=indicator]
Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4