JavaScript Figure Reference: Single-Page
How are Plotly attributes organized?
plotly.js charts are described declaratively as JSON objects. Every aspect of a plotly chart (the colors, the grids, the data, and so on) has a corresponding JSON attribute. This page contains an extensive list of these attributes.
Plotly's graph description places attributes into two categories: traces (objects that describe a single series of data in a graph) and layout (attributes that apply to the rest of the chart, like the title, xaxis, or annotations). Traces are categorized by chart type (e.g. scatter, heatmap).
Here is a simple example of a plotly chart inlined with links to each attribute's reference section.
data = [
{
type: 'scatter', // all "scatter" attributes: https://plotly.com/javascript/reference/#scatter
x: [1, 2, 3], // more about "x": #scatter-x
y: [3, 1, 6], // #scatter-y
marker: { // marker is an object, valid marker keys: #scatter-marker
color: 'rgb(16, 32, 77)' // more about "marker.color": #scatter-marker-color
}
},
{
type: 'bar', // all "bar" chart attributes: #bar
x: [1, 2, 3], // more about "x": #bar-x
y: [3, 1, 6], // #bar-y
name: 'bar chart example' // #bar-name
}
];
layout = { // all "layout" attributes: #layout
title: 'simple example', // more about "layout.title": #layout-title
xaxis: { // all "layout.xaxis" attributes: #layout-xaxis
title: 'time' // more about "layout.xaxis.title": #layout-xaxis-title
},
annotations: [ // all "annotation" attributes: #layout-annotations
{
text: 'simple annotation', // #layout-annotations-text
x: 0, // #layout-annotations-x
xref: 'paper', // #layout-annotations-xref
y: 0, // #layout-annotations-y
yref: 'paper' // #layout-annotations-yref
}
]
}
scatter traces
scatter trace is an object with the key "type" equal to "scatter" (i.e. {"type": "scatter"}) and any of the keys listed below. The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in `x` and `y`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays.
- type
Parent:data[type=scatter]
Type: "scatter" - name
Parent:data[type=scatter]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=scatter]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=scatter]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=scatter]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=scatter]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=scatter]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scatter].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=scatter].legendgrouptitle.font
Type: color - family
Parent:data[type=scatter].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=scatter].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=scatter].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=scatter].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=scatter]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=scatter]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- mode
Parent:data[type=scatter]
Type: flaglist string. Any combination of"lines","markers","text"joined with a"+"OR"none".
Examples:"lines","markers","lines+markers","lines+markers+text","none"Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
- ids
Parent:data[type=scatter]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=scatter]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=scatter]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=scatter]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=scatter]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- y
Parent:data[type=scatter]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=scatter]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=scatter]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- text
Parent:data[type=scatter]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=scatter]
Type: enumerated or array of enumerateds , one of ("top left"|"top center"|"top right"|"middle left"|"middle center"|"middle right"|"bottom left"|"bottom center"|"bottom right")
Default:"middle center"Sets the positions of the `text` elements with respects to the (x,y) coordinates.
- texttemplate
Parent:data[type=scatter]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.
- texttemplatefallback
Parent:data[type=scatter]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=scatter]
Type: string or array of strings
Default:""Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=scatter]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=scatter]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=scatter]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=scatter]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=scatter]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=scatter]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=scatter]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=scatter]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=scatter]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=scatter]
Type: enumerated , one of ("v"|"h")Only relevant in the following cases: 1. when `scattermode` is set to "group". 2. when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.
- groupnorm
Parent:data[type=scatter]
Type: enumerated , one of (""|"fraction"|"percent")
Default:""Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each trace at each location is divided by the sum of all trace values at that location. "percent" is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.
- alignmentgroup
Parent:data[type=scatter]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=scatter]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- stackgroup
Parent:data[type=scatter]
Type: string
Default:""Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is "h"). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
- xperiod
Parent:data[type=scatter]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=scatter]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=scatter]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=scatter]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=scatter]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=scatter]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- marker
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- angle
Parent:data[type=scatter].marker
Type: angle
Default:0Sets the marker angle in respect to `angleref`.
- angleref
Parent:data[type=scatter].marker
Type: enumerated , one of ("previous"|"up")
Default:"up"Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.
- autocolorscale
Parent:data[type=scatter].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scatter].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=scatter].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=scatter].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=scatter].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=scatter].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=scatter].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=scatter].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=scatter].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=scatter].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=scatter].marker.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=scatter].marker.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=scatter].marker.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=scatter].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=scatter].marker.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=scatter].marker.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=scatter].marker.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=scatter].marker.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=scatter].marker.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=scatter].marker.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=scatter].marker.colorbar.tickfont
Type: color - family
Parent:data[type=scatter].marker.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter].marker.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter].marker.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=scatter].marker.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=scatter].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter].marker.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=scatter].marker.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=scatter].marker.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=scatter].marker.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=scatter].marker.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=scatter].marker.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=scatter].marker.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=scatter].marker.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=scatter].marker.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=scatter].marker.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=scatter].marker.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=scatter].marker.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=scatter].marker.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=scatter].marker.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scatter].marker.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=scatter].marker.colorbar.title.font
Type: color - family
Parent:data[type=scatter].marker.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter].marker.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter].marker.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=scatter].marker.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=scatter].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter].marker.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=scatter].marker.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=scatter].marker.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=scatter].marker.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=scatter].marker.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=scatter].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=scatter].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=scatter].marker
Type: colorscaleSets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- gradient
Parent:data[type=scatter].marker
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scatter].marker.gradient
Type: color or array of colorsSets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
- type
Parent:data[type=scatter].marker.gradient
Type: enumerated or array of enumerateds , one of ("radial"|"horizontal"|"vertical"|"none")
Default:"none"Sets the type of gradient used to fill the markers
- color
- line
Parent:data[type=scatter].marker
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=scatter].marker.line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scatter].marker.line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
- cmax
Parent:data[type=scatter].marker.line
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
- cmid
Parent:data[type=scatter].marker.line
Type: numberSets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.
- cmin
Parent:data[type=scatter].marker.line
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
- color
Parent:data[type=scatter].marker.line
Type: color or array of colorsSets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- coloraxis
Parent:data[type=scatter].marker.line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorscale
Parent:data[type=scatter].marker.line
Type: colorscaleSets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- dash
Parent:data[type=scatter].marker.line
Type: string or array of strings
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- reversescale
Parent:data[type=scatter].marker.line
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
- width
Parent:data[type=scatter].marker.line
Type: number or array of numbers greater than or equal to 0Sets the width (in px) of the lines bounding the marker points.
- autocolorscale
- maxdisplayed
Parent:data[type=scatter].marker
Type: number greater than or equal to 0
Default:0Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
- opacity
Parent:data[type=scatter].marker
Type: number or array of numbers between or equal to 0 and 1Sets the marker opacity.
- reversescale
Parent:data[type=scatter].marker
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
- showscale
Parent:data[type=scatter].marker
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.
- size
Parent:data[type=scatter].marker
Type: number or array of numbers greater than or equal to 0
Default:6Sets the marker size (in px).
- sizemin
Parent:data[type=scatter].marker
Type: number greater than or equal to 0
Default:0Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
- sizemode
Parent:data[type=scatter].marker
Type: enumerated , one of ("diameter"|"area")
Default:"diameter"Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
- sizeref
Parent:data[type=scatter].marker
Type: number
Default:1Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
- standoff
Parent:data[type=scatter].marker
Type: number or array of numbers greater than or equal to 0
Default:0Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
- symbol
Parent:data[type=scatter].marker
Type: enumerated or array of enumerateds , one of ("0"|"0"|"circle"|"100"|"100"|"circle-open"|"200"|"200"|"circle-dot"|"300"|"300"|"circle-open-dot"|"1"|"1"|"square"|"101"|"101"|"square-open"|"201"|"201"|"square-dot"|"301"|"301"|"square-open-dot"|"2"|"2"|"diamond"|"102"|"102"|"diamond-open"|"202"|"202"|"diamond-dot"|"302"|"302"|"diamond-open-dot"|"3"|"3"|"cross"|"103"|"103"|"cross-open"|"203"|"203"|"cross-dot"|"303"|"303"|"cross-open-dot"|"4"|"4"|"x"|"104"|"104"|"x-open"|"204"|"204"|"x-dot"|"304"|"304"|"x-open-dot"|"5"|"5"|"triangle-up"|"105"|"105"|"triangle-up-open"|"205"|"205"|"triangle-up-dot"|"305"|"305"|"triangle-up-open-dot"|"6"|"6"|"triangle-down"|"106"|"106"|"triangle-down-open"|"206"|"206"|"triangle-down-dot"|"306"|"306"|"triangle-down-open-dot"|"7"|"7"|"triangle-left"|"107"|"107"|"triangle-left-open"|"207"|"207"|"triangle-left-dot"|"307"|"307"|"triangle-left-open-dot"|"8"|"8"|"triangle-right"|"108"|"108"|"triangle-right-open"|"208"|"208"|"triangle-right-dot"|"308"|"308"|"triangle-right-open-dot"|"9"|"9"|"triangle-ne"|"109"|"109"|"triangle-ne-open"|"209"|"209"|"triangle-ne-dot"|"309"|"309"|"triangle-ne-open-dot"|"10"|"10"|"triangle-se"|"110"|"110"|"triangle-se-open"|"210"|"210"|"triangle-se-dot"|"310"|"310"|"triangle-se-open-dot"|"11"|"11"|"triangle-sw"|"111"|"111"|"triangle-sw-open"|"211"|"211"|"triangle-sw-dot"|"311"|"311"|"triangle-sw-open-dot"|"12"|"12"|"triangle-nw"|"112"|"112"|"triangle-nw-open"|"212"|"212"|"triangle-nw-dot"|"312"|"312"|"triangle-nw-open-dot"|"13"|"13"|"pentagon"|"113"|"113"|"pentagon-open"|"213"|"213"|"pentagon-dot"|"313"|"313"|"pentagon-open-dot"|"14"|"14"|"hexagon"|"114"|"114"|"hexagon-open"|"214"|"214"|"hexagon-dot"|"314"|"314"|"hexagon-open-dot"|"15"|"15"|"hexagon2"|"115"|"115"|"hexagon2-open"|"215"|"215"|"hexagon2-dot"|"315"|"315"|"hexagon2-open-dot"|"16"|"16"|"octagon"|"116"|"116"|"octagon-open"|"216"|"216"|"octagon-dot"|"316"|"316"|"octagon-open-dot"|"17"|"17"|"star"|"117"|"117"|"star-open"|"217"|"217"|"star-dot"|"317"|"317"|"star-open-dot"|"18"|"18"|"hexagram"|"118"|"118"|"hexagram-open"|"218"|"218"|"hexagram-dot"|"318"|"318"|"hexagram-open-dot"|"19"|"19"|"star-triangle-up"|"119"|"119"|"star-triangle-up-open"|"219"|"219"|"star-triangle-up-dot"|"319"|"319"|"star-triangle-up-open-dot"|"20"|"20"|"star-triangle-down"|"120"|"120"|"star-triangle-down-open"|"220"|"220"|"star-triangle-down-dot"|"320"|"320"|"star-triangle-down-open-dot"|"21"|"21"|"star-square"|"121"|"121"|"star-square-open"|"221"|"221"|"star-square-dot"|"321"|"321"|"star-square-open-dot"|"22"|"22"|"star-diamond"|"122"|"122"|"star-diamond-open"|"222"|"222"|"star-diamond-dot"|"322"|"322"|"star-diamond-open-dot"|"23"|"23"|"diamond-tall"|"123"|"123"|"diamond-tall-open"|"223"|"223"|"diamond-tall-dot"|"323"|"323"|"diamond-tall-open-dot"|"24"|"24"|"diamond-wide"|"124"|"124"|"diamond-wide-open"|"224"|"224"|"diamond-wide-dot"|"324"|"324"|"diamond-wide-open-dot"|"25"|"25"|"hourglass"|"125"|"125"|"hourglass-open"|"26"|"26"|"bowtie"|"126"|"126"|"bowtie-open"|"27"|"27"|"circle-cross"|"127"|"127"|"circle-cross-open"|"28"|"28"|"circle-x"|"128"|"128"|"circle-x-open"|"29"|"29"|"square-cross"|"129"|"129"|"square-cross-open"|"30"|"30"|"square-x"|"130"|"130"|"square-x-open"|"31"|"31"|"diamond-cross"|"131"|"131"|"diamond-cross-open"|"32"|"32"|"diamond-x"|"132"|"132"|"diamond-x-open"|"33"|"33"|"cross-thin"|"133"|"133"|"cross-thin-open"|"34"|"34"|"x-thin"|"134"|"134"|"x-thin-open"|"35"|"35"|"asterisk"|"135"|"135"|"asterisk-open"|"36"|"36"|"hash"|"136"|"136"|"hash-open"|"236"|"236"|"hash-dot"|"336"|"336"|"hash-open-dot"|"37"|"37"|"y-up"|"137"|"137"|"y-up-open"|"38"|"38"|"y-down"|"138"|"138"|"y-down-open"|"39"|"39"|"y-left"|"139"|"139"|"y-left-open"|"40"|"40"|"y-right"|"140"|"140"|"y-right-open"|"41"|"41"|"line-ew"|"141"|"141"|"line-ew-open"|"42"|"42"|"line-ns"|"142"|"142"|"line-ns-open"|"43"|"43"|"line-ne"|"143"|"143"|"line-ne-open"|"44"|"44"|"line-nw"|"144"|"144"|"line-nw-open"|"45"|"45"|"arrow-up"|"145"|"145"|"arrow-up-open"|"46"|"46"|"arrow-down"|"146"|"146"|"arrow-down-open"|"47"|"47"|"arrow-left"|"147"|"147"|"arrow-left-open"|"48"|"48"|"arrow-right"|"148"|"148"|"arrow-right-open"|"49"|"49"|"arrow-bar-up"|"149"|"149"|"arrow-bar-up-open"|"50"|"50"|"arrow-bar-down"|"150"|"150"|"arrow-bar-down-open"|"51"|"51"|"arrow-bar-left"|"151"|"151"|"arrow-bar-left-open"|"52"|"52"|"arrow-bar-right"|"152"|"152"|"arrow-bar-right-open"|"53"|"53"|"arrow"|"153"|"153"|"arrow-open"|"54"|"54"|"arrow-wide"|"154"|"154"|"arrow-wide-open")
Default:"circle"Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
- angle
- line
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- backoff
Parent:data[type=scatter].line
Type: number or array of numbers greater than or equal to 0
Default:"auto"Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous".
- color
Parent:data[type=scatter].line
Type: colorSets the line color.
- dash
Parent:data[type=scatter].line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- shape
Parent:data[type=scatter].line
Type: enumerated , one of ("linear"|"spline"|"hv"|"vh"|"hvh"|"vhv")
Default:"linear"Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
- simplify
Parent:data[type=scatter].line
Type: boolean
Default:trueSimplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.
- smoothing
Parent:data[type=scatter].line
Type: number between or equal to 0 and 1.3
Default:1Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
- width
Parent:data[type=scatter].line
Type: number greater than or equal to 0
Default:2Sets the line width (in px).
- backoff
- textfont
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.Sets the text font.
- color
Parent:data[type=scatter].textfont
Type: color or array of colors - family
Parent:data[type=scatter].textfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=scatter].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter].textfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=scatter].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=scatter].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- error_x
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scatter].error_x
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scatter].error_x
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scatter].error_x
Type: colorSets the stroke color of the error bars.
- copy_ystyle
Parent:data[type=scatter].error_x
Type: boolean - symmetric
Parent:data[type=scatter].error_x
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scatter].error_x
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scatter].error_x
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scatter].error_x
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scatter].error_x
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scatter].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scatter].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scatter].error_x
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scatter].error_x
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- error_y
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scatter].error_y
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scatter].error_y
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scatter].error_y
Type: colorSets the stroke color of the error bars.
- symmetric
Parent:data[type=scatter].error_y
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scatter].error_y
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scatter].error_y
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scatter].error_y
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scatter].error_y
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scatter].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scatter].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scatter].error_y
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scatter].error_y
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- selectedpoints
Parent:data[type=scatter]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- selected
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=scatter].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scatter].selected.marker
Type: colorSets the marker color of selected points.
- opacity
Parent:data[type=scatter].selected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of selected points.
- size
Parent:data[type=scatter].selected.marker
Type: number greater than or equal to 0Sets the marker size of selected points.
- color
- textfont
Parent:data[type=scatter].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scatter].selected.textfont
Type: colorSets the text font color of selected points.
- color
- marker
- unselected
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=scatter].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scatter].unselected.marker
Type: colorSets the marker color of unselected points, applied only when a selection exists.
- opacity
Parent:data[type=scatter].unselected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of unselected points, applied only when a selection exists.
- size
Parent:data[type=scatter].unselected.marker
Type: number greater than or equal to 0Sets the marker size of unselected points, applied only when a selection exists.
- color
- textfont
Parent:data[type=scatter].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scatter].unselected.textfont
Type: colorSets the text font color of unselected points, applied only when a selection exists.
- color
- marker
- cliponaxis
Parent:data[type=scatter]
Type: boolean
Default:trueDetermines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
- connectgaps
Parent:data[type=scatter]
Type: booleanDetermines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
- fill
Parent:data[type=scatter]
Type: enumerated , one of ("none"|"tozeroy"|"tozerox"|"tonexty"|"tonextx"|"toself"|"tonext")Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
- fillcolor
Parent:data[type=scatter]
Type: colorSets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.
- fillgradient
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.Sets a fill gradient. If not specified, the fillcolor is used instead.
- colorscale
Parent:data[type=scatter].fillgradient
Type: colorscaleSets the fill gradient colors as a color scale. The color scale is interpreted as a gradient applied in the direction specified by "orientation", from the lowest to the highest value of the scatter plot along that axis, or from the center to the most distant point from it, if orientation is "radial".
- start
Parent:data[type=scatter].fillgradient
Type: numberSets the gradient start value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is "horizontal", the gradient will be horizontal and start from the x-position given by start. If omitted, the gradient starts at the lowest value of the trace along the respective axis. Ignored if orientation is "radial".
- stop
Parent:data[type=scatter].fillgradient
Type: numberSets the gradient end value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is "horizontal", the gradient will be horizontal and end at the x-position given by end. If omitted, the gradient ends at the highest value of the trace along the respective axis. Ignored if orientation is "radial".
- type
Parent:data[type=scatter].fillgradient
Type: enumerated , one of ("radial"|"horizontal"|"vertical"|"none")
Default:"none"Sets the type/orientation of the color gradient for the fill. Defaults to "none".
- colorscale
- fillpattern
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.Sets the pattern within the marker.
- bgcolor
Parent:data[type=scatter].fillpattern
Type: color or array of colorsWhen there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is "overlay". Otherwise, defaults to a transparent background.
- fgcolor
Parent:data[type=scatter].fillpattern
Type: color or array of colorsWhen there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is "replace". Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.
- fgopacity
Parent:data[type=scatter].fillpattern
Type: number between or equal to 0 and 1Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
- fillmode
Parent:data[type=scatter].fillpattern
Type: enumerated , one of ("replace"|"overlay")
Default:"replace"Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.
- path
Parent:data[type=scatter].fillpattern
Type: string or array of stringsSets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.
- shape
Parent:data[type=scatter].fillpattern
Type: enumerated or array of enumerateds , one of (""|"/"|"\"|"x"|"-"|"|"|"+"|".")
Default:""Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- size
Parent:data[type=scatter].fillpattern
Type: number or array of numbers greater than or equal to 0
Default:8Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- solidity
Parent:data[type=scatter].fillpattern
Type: number or array of numbers between or equal to 0 and 1
Default:0.3Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- bgcolor
- hoverlabel
Parent:data[type=scatter]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=scatter].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=scatter].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=scatter].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=scatter].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=scatter].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=scatter].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=scatter].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=scatter].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=scatter].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=scatter].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=scatter].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- hoveron
Parent:data[type=scatter]
Type: flaglist string. Any combination of"points","fills"joined with a"+"
Examples:"points","fills","points+fills"Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".
- stackgaps
Parent:data[type=scatter]
Type: enumerated , one of ("infer zero"|"interpolate")
Default:"infer zero"Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With "infer zero" we insert a zero at these locations. With "interpolate" we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.
- xcalendar
Parent:data[type=scatter]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=scatter]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=scatter]
Type: number or categorical coordinate stringControls 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.
scattergl traces
scattergl trace is an object with the key "type" equal to "scattergl" (i.e. {"type": "scattergl"}) and any of the keys listed below. The data visualized as scatter point or lines is set in `x` and `y` using the WebGL plotting engine. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.
- type
Parent:data[type=scattergl]
Type: "scattergl" - name
Parent:data[type=scattergl]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=scattergl]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=scattergl]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=scattergl]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=scattergl]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=scattergl]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scattergl].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=scattergl].legendgrouptitle.font
Type: color - family
Parent:data[type=scattergl].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scattergl].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scattergl].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=scattergl].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=scattergl].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scattergl].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scattergl].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scattergl].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=scattergl].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=scattergl]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=scattergl]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- mode
Parent:data[type=scattergl]
Type: flaglist string. Any combination of"lines","markers","text"joined with a"+"OR"none".
Examples:"lines","markers","lines+markers","lines+markers+text","none"Determines the drawing mode for this scatter trace.
- ids
Parent:data[type=scattergl]
Type: data arrayAssigns 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.
- x
Parent:data[type=scattergl]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=scattergl]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=scattergl]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- y
Parent:data[type=scattergl]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=scattergl]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=scattergl]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- text
Parent:data[type=scattergl]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=scattergl]
Type: enumerated or array of enumerateds , one of ("top left"|"top center"|"top right"|"middle left"|"middle center"|"middle right"|"bottom left"|"bottom center"|"bottom right")
Default:"middle center"Sets the positions of the `text` elements with respects to the (x,y) coordinates.
- texttemplate
Parent:data[type=scattergl]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.
- texttemplatefallback
Parent:data[type=scattergl]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=scattergl]
Type: string or array of strings
Default:""Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=scattergl]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=scattergl]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=scattergl]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=scattergl]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=scattergl]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=scattergl]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=scattergl]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=scattergl]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=scattergl]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- xperiod
Parent:data[type=scattergl]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=scattergl]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=scattergl]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=scattergl]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=scattergl]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=scattergl]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- marker
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- angle
Parent:data[type=scattergl].marker
Type: angle
Default:0Sets the marker angle in respect to `angleref`.
- autocolorscale
Parent:data[type=scattergl].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scattergl].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=scattergl].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=scattergl].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=scattergl].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=scattergl].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=scattergl].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=scattergl].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=scattergl].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=scattergl].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=scattergl].marker.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=scattergl].marker.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=scattergl].marker.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=scattergl].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=scattergl].marker.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=scattergl].marker.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=scattergl].marker.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=scattergl].marker.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=scattergl].marker.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=scattergl].marker.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: color - family
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scattergl].marker.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=scattergl].marker.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=scattergl].marker.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=scattergl].marker.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=scattergl].marker.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=scattergl].marker.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=scattergl].marker.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=scattergl].marker.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=scattergl].marker.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=scattergl].marker.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=scattergl].marker.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=scattergl].marker.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=scattergl].marker.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=scattergl].marker.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scattergl].marker.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=scattergl].marker.colorbar.title.font
Type: color - family
Parent:data[type=scattergl].marker.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scattergl].marker.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scattergl].marker.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=scattergl].marker.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=scattergl].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scattergl].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scattergl].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scattergl].marker.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=scattergl].marker.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=scattergl].marker.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=scattergl].marker.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=scattergl].marker.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=scattergl].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=scattergl].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=scattergl].marker
Type: colorscaleSets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- line
Parent:data[type=scattergl].marker
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=scattergl].marker.line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scattergl].marker.line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
- cmax
Parent:data[type=scattergl].marker.line
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
- cmid
Parent:data[type=scattergl].marker.line
Type: numberSets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.
- cmin
Parent:data[type=scattergl].marker.line
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
- color
Parent:data[type=scattergl].marker.line
Type: color or array of colorsSets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- coloraxis
Parent:data[type=scattergl].marker.line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorscale
Parent:data[type=scattergl].marker.line
Type: colorscaleSets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- reversescale
Parent:data[type=scattergl].marker.line
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
- width
Parent:data[type=scattergl].marker.line
Type: number or array of numbers greater than or equal to 0Sets the width (in px) of the lines bounding the marker points.
- autocolorscale
- opacity
Parent:data[type=scattergl].marker
Type: number or array of numbers between or equal to 0 and 1Sets the marker opacity.
- reversescale
Parent:data[type=scattergl].marker
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
- showscale
Parent:data[type=scattergl].marker
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.
- size
Parent:data[type=scattergl].marker
Type: number or array of numbers greater than or equal to 0
Default:6Sets the marker size (in px).
- sizemin
Parent:data[type=scattergl].marker
Type: number greater than or equal to 0
Default:0Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
- sizemode
Parent:data[type=scattergl].marker
Type: enumerated , one of ("diameter"|"area")
Default:"diameter"Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
- sizeref
Parent:data[type=scattergl].marker
Type: number
Default:1Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
- symbol
Parent:data[type=scattergl].marker
Type: enumerated or array of enumerateds , one of ("0"|"0"|"circle"|"100"|"100"|"circle-open"|"200"|"200"|"circle-dot"|"300"|"300"|"circle-open-dot"|"1"|"1"|"square"|"101"|"101"|"square-open"|"201"|"201"|"square-dot"|"301"|"301"|"square-open-dot"|"2"|"2"|"diamond"|"102"|"102"|"diamond-open"|"202"|"202"|"diamond-dot"|"302"|"302"|"diamond-open-dot"|"3"|"3"|"cross"|"103"|"103"|"cross-open"|"203"|"203"|"cross-dot"|"303"|"303"|"cross-open-dot"|"4"|"4"|"x"|"104"|"104"|"x-open"|"204"|"204"|"x-dot"|"304"|"304"|"x-open-dot"|"5"|"5"|"triangle-up"|"105"|"105"|"triangle-up-open"|"205"|"205"|"triangle-up-dot"|"305"|"305"|"triangle-up-open-dot"|"6"|"6"|"triangle-down"|"106"|"106"|"triangle-down-open"|"206"|"206"|"triangle-down-dot"|"306"|"306"|"triangle-down-open-dot"|"7"|"7"|"triangle-left"|"107"|"107"|"triangle-left-open"|"207"|"207"|"triangle-left-dot"|"307"|"307"|"triangle-left-open-dot"|"8"|"8"|"triangle-right"|"108"|"108"|"triangle-right-open"|"208"|"208"|"triangle-right-dot"|"308"|"308"|"triangle-right-open-dot"|"9"|"9"|"triangle-ne"|"109"|"109"|"triangle-ne-open"|"209"|"209"|"triangle-ne-dot"|"309"|"309"|"triangle-ne-open-dot"|"10"|"10"|"triangle-se"|"110"|"110"|"triangle-se-open"|"210"|"210"|"triangle-se-dot"|"310"|"310"|"triangle-se-open-dot"|"11"|"11"|"triangle-sw"|"111"|"111"|"triangle-sw-open"|"211"|"211"|"triangle-sw-dot"|"311"|"311"|"triangle-sw-open-dot"|"12"|"12"|"triangle-nw"|"112"|"112"|"triangle-nw-open"|"212"|"212"|"triangle-nw-dot"|"312"|"312"|"triangle-nw-open-dot"|"13"|"13"|"pentagon"|"113"|"113"|"pentagon-open"|"213"|"213"|"pentagon-dot"|"313"|"313"|"pentagon-open-dot"|"14"|"14"|"hexagon"|"114"|"114"|"hexagon-open"|"214"|"214"|"hexagon-dot"|"314"|"314"|"hexagon-open-dot"|"15"|"15"|"hexagon2"|"115"|"115"|"hexagon2-open"|"215"|"215"|"hexagon2-dot"|"315"|"315"|"hexagon2-open-dot"|"16"|"16"|"octagon"|"116"|"116"|"octagon-open"|"216"|"216"|"octagon-dot"|"316"|"316"|"octagon-open-dot"|"17"|"17"|"star"|"117"|"117"|"star-open"|"217"|"217"|"star-dot"|"317"|"317"|"star-open-dot"|"18"|"18"|"hexagram"|"118"|"118"|"hexagram-open"|"218"|"218"|"hexagram-dot"|"318"|"318"|"hexagram-open-dot"|"19"|"19"|"star-triangle-up"|"119"|"119"|"star-triangle-up-open"|"219"|"219"|"star-triangle-up-dot"|"319"|"319"|"star-triangle-up-open-dot"|"20"|"20"|"star-triangle-down"|"120"|"120"|"star-triangle-down-open"|"220"|"220"|"star-triangle-down-dot"|"320"|"320"|"star-triangle-down-open-dot"|"21"|"21"|"star-square"|"121"|"121"|"star-square-open"|"221"|"221"|"star-square-dot"|"321"|"321"|"star-square-open-dot"|"22"|"22"|"star-diamond"|"122"|"122"|"star-diamond-open"|"222"|"222"|"star-diamond-dot"|"322"|"322"|"star-diamond-open-dot"|"23"|"23"|"diamond-tall"|"123"|"123"|"diamond-tall-open"|"223"|"223"|"diamond-tall-dot"|"323"|"323"|"diamond-tall-open-dot"|"24"|"24"|"diamond-wide"|"124"|"124"|"diamond-wide-open"|"224"|"224"|"diamond-wide-dot"|"324"|"324"|"diamond-wide-open-dot"|"25"|"25"|"hourglass"|"125"|"125"|"hourglass-open"|"26"|"26"|"bowtie"|"126"|"126"|"bowtie-open"|"27"|"27"|"circle-cross"|"127"|"127"|"circle-cross-open"|"28"|"28"|"circle-x"|"128"|"128"|"circle-x-open"|"29"|"29"|"square-cross"|"129"|"129"|"square-cross-open"|"30"|"30"|"square-x"|"130"|"130"|"square-x-open"|"31"|"31"|"diamond-cross"|"131"|"131"|"diamond-cross-open"|"32"|"32"|"diamond-x"|"132"|"132"|"diamond-x-open"|"33"|"33"|"cross-thin"|"133"|"133"|"cross-thin-open"|"34"|"34"|"x-thin"|"134"|"134"|"x-thin-open"|"35"|"35"|"asterisk"|"135"|"135"|"asterisk-open"|"36"|"36"|"hash"|"136"|"136"|"hash-open"|"236"|"236"|"hash-dot"|"336"|"336"|"hash-open-dot"|"37"|"37"|"y-up"|"137"|"137"|"y-up-open"|"38"|"38"|"y-down"|"138"|"138"|"y-down-open"|"39"|"39"|"y-left"|"139"|"139"|"y-left-open"|"40"|"40"|"y-right"|"140"|"140"|"y-right-open"|"41"|"41"|"line-ew"|"141"|"141"|"line-ew-open"|"42"|"42"|"line-ns"|"142"|"142"|"line-ns-open"|"43"|"43"|"line-ne"|"143"|"143"|"line-ne-open"|"44"|"44"|"line-nw"|"144"|"144"|"line-nw-open"|"45"|"45"|"arrow-up"|"145"|"145"|"arrow-up-open"|"46"|"46"|"arrow-down"|"146"|"146"|"arrow-down-open"|"47"|"47"|"arrow-left"|"147"|"147"|"arrow-left-open"|"48"|"48"|"arrow-right"|"148"|"148"|"arrow-right-open"|"49"|"49"|"arrow-bar-up"|"149"|"149"|"arrow-bar-up-open"|"50"|"50"|"arrow-bar-down"|"150"|"150"|"arrow-bar-down-open"|"51"|"51"|"arrow-bar-left"|"151"|"151"|"arrow-bar-left-open"|"52"|"52"|"arrow-bar-right"|"152"|"152"|"arrow-bar-right-open"|"53"|"53"|"arrow"|"153"|"153"|"arrow-open"|"54"|"54"|"arrow-wide"|"154"|"154"|"arrow-wide-open")
Default:"circle"Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
- angle
- line
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scattergl].line
Type: colorSets the line color.
- dash
Parent:data[type=scattergl].line
Type: enumerated , one of ("dash"|"dashdot"|"dot"|"longdash"|"longdashdot"|"solid")
Default:"solid"Sets the style of the lines.
- shape
Parent:data[type=scattergl].line
Type: enumerated , one of ("linear"|"hv"|"vh"|"hvh"|"vhv")
Default:"linear"Determines the line shape. The values correspond to step-wise line shapes.
- width
Parent:data[type=scattergl].line
Type: number greater than or equal to 0
Default:2Sets the line width (in px).
- color
- textfont
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.Sets the text font.
- color
Parent:data[type=scattergl].textfont
Type: color or array of colors - family
Parent:data[type=scattergl].textfont
Type: string or array of stringsHTML 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.
- size
Parent:data[type=scattergl].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=scattergl].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- variant
Parent:data[type=scattergl].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scattergl].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"bold")
Default:"normal"Sets the weight (or boldness) of the font.
- color
- error_x
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scattergl].error_x
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scattergl].error_x
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scattergl].error_x
Type: colorSets the stroke color of the error bars.
- copy_ystyle
Parent:data[type=scattergl].error_x
Type: boolean - symmetric
Parent:data[type=scattergl].error_x
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scattergl].error_x
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scattergl].error_x
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scattergl].error_x
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scattergl].error_x
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scattergl].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scattergl].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scattergl].error_x
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scattergl].error_x
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- error_y
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scattergl].error_y
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scattergl].error_y
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scattergl].error_y
Type: colorSets the stroke color of the error bars.
- symmetric
Parent:data[type=scattergl].error_y
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scattergl].error_y
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scattergl].error_y
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scattergl].error_y
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scattergl].error_y
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scattergl].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scattergl].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scattergl].error_y
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scattergl].error_y
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- selectedpoints
Parent:data[type=scattergl]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- selected
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=scattergl].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scattergl].selected.marker
Type: colorSets the marker color of selected points.
- opacity
Parent:data[type=scattergl].selected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of selected points.
- size
Parent:data[type=scattergl].selected.marker
Type: number greater than or equal to 0Sets the marker size of selected points.
- color
- textfont
Parent:data[type=scattergl].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scattergl].selected.textfont
Type: colorSets the text font color of selected points.
- color
- marker
- unselected
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=scattergl].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scattergl].unselected.marker
Type: colorSets the marker color of unselected points, applied only when a selection exists.
- opacity
Parent:data[type=scattergl].unselected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of unselected points, applied only when a selection exists.
- size
Parent:data[type=scattergl].unselected.marker
Type: number greater than or equal to 0Sets the marker size of unselected points, applied only when a selection exists.
- color
- textfont
Parent:data[type=scattergl].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=scattergl].unselected.textfont
Type: colorSets the text font color of unselected points, applied only when a selection exists.
- color
- marker
- connectgaps
Parent:data[type=scattergl]
Type: booleanDetermines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
- fill
Parent:data[type=scattergl]
Type: enumerated , one of ("none"|"tozeroy"|"tozerox"|"tonexty"|"tonextx"|"toself"|"tonext")
Default:"none"Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
- fillcolor
Parent:data[type=scattergl]
Type: colorSets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- hoverlabel
Parent:data[type=scattergl]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=scattergl].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=scattergl].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=scattergl].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=scattergl].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=scattergl].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=scattergl].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=scattergl].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scattergl].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=scattergl].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=scattergl].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scattergl].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scattergl].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scattergl].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=scattergl].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=scattergl].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- xcalendar
Parent:data[type=scattergl]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=scattergl]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=scattergl]
Type: number or categorical coordinate stringControls 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.
bar traces
bar trace is an object with the key "type" equal to "bar" (i.e. {"type": "bar"}) and any of the keys listed below. The data visualized by the span of the bars is set in `y` if `orientation` is set to "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.
- type
Parent:data[type=bar]
Type: "bar" - name
Parent:data[type=bar]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=bar]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=bar]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=bar]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=bar]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=bar]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=bar].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=bar].legendgrouptitle.font
Type: color - family
Parent:data[type=bar].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=bar].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=bar].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=bar].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=bar].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=bar]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=bar]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=bar]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=bar]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=bar]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=bar]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=bar]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- y
Parent:data[type=bar]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=bar]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=bar]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- base
Parent:data[type=bar]
Type: number or categorical coordinate stringSets where the bar base is drawn (in position axis units). In "stack" or "relative" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead.
- width
Parent:data[type=bar]
Type: number or array of numbers greater than or equal to 0Sets the bar width (in position axis units).
- offset
Parent:data[type=bar]
Type: number or array of numbersShifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.
- text
Parent:data[type=bar]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=bar]
Type: enumerated or array of enumerateds , one of ("inside"|"outside"|"auto"|"none")
Default:"auto"Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If "none", no text appears.
- texttemplate
Parent:data[type=bar]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `value` and `label`.
- texttemplatefallback
Parent:data[type=bar]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=bar]
Type: string or array of strings
Default:""Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=bar]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=bar]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `value` and `label`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=bar]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=bar]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=bar]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=bar]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=bar]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=bar]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=bar]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=bar]
Type: enumerated , one of ("v"|"h")Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
- alignmentgroup
Parent:data[type=bar]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=bar]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- xperiod
Parent:data[type=bar]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=bar]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=bar]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=bar]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=bar]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=bar]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- marker
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=bar].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=bar].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=bar].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=bar].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=bar].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=bar].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=bar].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=bar].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=bar].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=bar].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=bar].marker.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=bar].marker.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=bar].marker.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=bar].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=bar].marker.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=bar].marker.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=bar].marker.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=bar].marker.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=bar].marker.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=bar].marker.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=bar].marker.colorbar.tickfont
Type: color - family
Parent:data[type=bar].marker.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=bar].marker.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].marker.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=bar].marker.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=bar].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].marker.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=bar].marker.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=bar].marker.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=bar].marker.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=bar].marker.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=bar].marker.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=bar].marker.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=bar].marker.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=bar].marker.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=bar].marker.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=bar].marker.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=bar].marker.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=bar].marker.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=bar].marker.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=bar].marker.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=bar].marker.colorbar.title.font
Type: color - family
Parent:data[type=bar].marker.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=bar].marker.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].marker.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=bar].marker.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=bar].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].marker.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=bar].marker.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=bar].marker.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=bar].marker.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=bar].marker.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=bar].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=bar].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=bar].marker
Type: colorscaleSets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- cornerradius
Parent:data[type=bar].marker
Type: number or categorical coordinate stringSets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to `layout.barcornerradius`. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.
- line
Parent:data[type=bar].marker
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=bar].marker.line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=bar].marker.line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
- cmax
Parent:data[type=bar].marker.line
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
- cmid
Parent:data[type=bar].marker.line
Type: numberSets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.
- cmin
Parent:data[type=bar].marker.line
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
- color
Parent:data[type=bar].marker.line
Type: color or array of colorsSets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- coloraxis
Parent:data[type=bar].marker.line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorscale
Parent:data[type=bar].marker.line
Type: colorscaleSets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- reversescale
Parent:data[type=bar].marker.line
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
- width
Parent:data[type=bar].marker.line
Type: number or array of numbers greater than or equal to 0
Default:0Sets the width (in px) of the lines bounding the marker points.
- autocolorscale
- opacity
Parent:data[type=bar].marker
Type: number or array of numbers between or equal to 0 and 1
Default:1Sets the opacity of the bars.
- pattern
Parent:data[type=bar].marker
Type: object containing one or more of the keys listed below.Sets the pattern within the marker.
- bgcolor
Parent:data[type=bar].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is "overlay". Otherwise, defaults to a transparent background.
- fgcolor
Parent:data[type=bar].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is "replace". Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.
- fgopacity
Parent:data[type=bar].marker.pattern
Type: number between or equal to 0 and 1Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
- fillmode
Parent:data[type=bar].marker.pattern
Type: enumerated , one of ("replace"|"overlay")
Default:"replace"Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.
- path
Parent:data[type=bar].marker.pattern
Type: string or array of stringsSets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.
- shape
Parent:data[type=bar].marker.pattern
Type: enumerated or array of enumerateds , one of (""|"/"|"\"|"x"|"-"|"|"|"+"|".")
Default:""Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- size
Parent:data[type=bar].marker.pattern
Type: number or array of numbers greater than or equal to 0
Default:8Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- solidity
Parent:data[type=bar].marker.pattern
Type: number or array of numbers between or equal to 0 and 1
Default:0.3Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- bgcolor
- reversescale
Parent:data[type=bar].marker
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
- showscale
Parent:data[type=bar].marker
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.
- autocolorscale
- textangle
Parent:data[type=bar]
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
- textfont
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.Sets the font used for `text`.
- color
Parent:data[type=bar].textfont
Type: color or array of colors - family
Parent:data[type=bar].textfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=bar].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].textfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=bar].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=bar].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- error_x
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=bar].error_x
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=bar].error_x
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=bar].error_x
Type: colorSets the stroke color of the error bars.
- copy_ystyle
Parent:data[type=bar].error_x
Type: boolean - symmetric
Parent:data[type=bar].error_x
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=bar].error_x
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=bar].error_x
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=bar].error_x
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=bar].error_x
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=bar].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=bar].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=bar].error_x
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=bar].error_x
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- error_y
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=bar].error_y
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=bar].error_y
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=bar].error_y
Type: colorSets the stroke color of the error bars.
- symmetric
Parent:data[type=bar].error_y
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=bar].error_y
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=bar].error_y
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=bar].error_y
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=bar].error_y
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=bar].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=bar].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=bar].error_y
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=bar].error_y
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- selectedpoints
Parent:data[type=bar]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- selected
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=bar].selected
Type: object containing one or more of the keys listed below. - textfont
Parent:data[type=bar].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=bar].selected.textfont
Type: colorSets the text font color of selected points.
- color
- marker
- unselected
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=bar].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=bar].unselected.marker
Type: colorSets the marker color of unselected points, applied only when a selection exists.
- opacity
Parent:data[type=bar].unselected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of unselected points, applied only when a selection exists.
- color
- textfont
Parent:data[type=bar].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=bar].unselected.textfont
Type: colorSets the text font color of unselected points, applied only when a selection exists.
- color
- marker
- cliponaxis
Parent:data[type=bar]
Type: boolean
Default:trueDetermines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
- constraintext
Parent:data[type=bar]
Type: enumerated , one of ("inside"|"outside"|"both"|"none")
Default:"both"Constrain the size of text inside or outside a bar to be no larger than the bar itself.
- hoverlabel
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=bar].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=bar].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=bar].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=bar].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=bar].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=bar].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=bar].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=bar].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=bar].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=bar].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=bar].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- insidetextanchor
Parent:data[type=bar]
Type: enumerated , one of ("end"|"middle"|"start")
Default:"end"Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
- insidetextfont
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying inside the bar.
- color
Parent:data[type=bar].insidetextfont
Type: color or array of colors - family
Parent:data[type=bar].insidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=bar].insidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].insidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=bar].insidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=bar].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].insidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- outsidetextfont
Parent:data[type=bar]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying outside the bar.
- color
Parent:data[type=bar].outsidetextfont
Type: color or array of colors - family
Parent:data[type=bar].outsidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=bar].outsidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=bar].outsidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=bar].outsidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=bar].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=bar].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=bar].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=bar].outsidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- xcalendar
Parent:data[type=bar]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=bar]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=bar]
Type: number or categorical coordinate stringControls 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.
pie traces
pie trace is an object with the key "type" equal to "pie" (i.e. {"type": "pie"}) and any of the keys listed below. A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`
- type
Parent:data[type=pie]
Type: "pie" - name
Parent:data[type=pie]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- title
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=pie].title
Type: object containing one or more of the keys listed below.Sets the font used for `title`.
- color
Parent:data[type=pie].title.font
Type: color or array of colors - family
Parent:data[type=pie].title.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=pie].title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=pie].title.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=pie].title.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=pie].title.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=pie].title.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=pie].title.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=pie].title.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- position
Parent:data[type=pie].title
Type: enumerated , one of ("top left"|"top center"|"top right"|"middle center"|"bottom left"|"bottom center"|"bottom right")Specifies the location of the `title`.
- text
Parent:data[type=pie].title
Type: string
Default:""Sets the title of the chart. If it is empty, no title is displayed.
- font
- visible
Parent:data[type=pie]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=pie]
Type: boolean or array of booleans
Default:trueDetermines whether or not items corresponding to the pie slices are shown in the legend. Can be an array if `values` is set. In that case, each entry specifies appearance in the legend for one slice.
- legend
Parent:data[type=pie]
Type: subplotid
Default:legendSets the reference to a legend to show the pie slices in. Can be an array if `values` is set. In that case, each entry specifies the legend reference for one slice. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.
- legendrank
Parent:data[type=pie]
Type: number or array of numbers
Default:1000Sets the legend rank for this pie. If passed as an array, this will set the legend rank of the individual pie slices. 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.
- legendgroup
Parent:data[type=pie]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=pie].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=pie].legendgrouptitle.font
Type: color - family
Parent:data[type=pie].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=pie].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=pie].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=pie].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=pie].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=pie].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=pie].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=pie].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=pie].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=pie]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=pie]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=pie]
Type: data arrayAssigns 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.
- values
Parent:data[type=pie]
Type: data arraySets the values of the sectors. If omitted, we count occurrences of each label.
- labels
Parent:data[type=pie]
Type: data arraySets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.
- dlabel
Parent:data[type=pie]
Type: number
Default:1Sets the label step. See `label0` for more info.
- label0
Parent:data[type=pie]
Type: number
Default:0Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
- pull
Parent:data[type=pie]
Type: number or array of numbers between or equal to 0 and 1
Default:0Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
- text
Parent:data[type=pie]
Type: data arraySets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=pie]
Type: enumerated or array of enumerateds , one of ("inside"|"outside"|"auto"|"none")
Default:"auto"Specifies the location of the `textinfo`.
- texttemplate
Parent:data[type=pie]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`.
- texttemplatefallback
Parent:data[type=pie]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=pie]
Type: string or array of strings
Default:""Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=pie]
Type: flaglist string. Any combination of"label","text","value","percent","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"label","text","label+text","label+text+value","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=pie]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=pie]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- meta
Parent:data[type=pie]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=pie]
Type: data arrayAssigns 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
- domain
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.- column
Parent:data[type=pie].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this column in the grid for this pie trace .
- row
Parent:data[type=pie].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this row in the grid for this pie trace .
- x
Parent:data[type=pie].domain
Type: array
Default:[0, 1]Sets the horizontal domain of this pie trace (in plot fraction).
- y
Parent:data[type=pie].domain
Type: array
Default:[0, 1]Sets the vertical domain of this pie trace (in plot fraction).
- column
- automargin
Parent:data[type=pie]
Type: booleanDetermines whether outside text labels can push the margins.
- marker
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.- colors
Parent:data[type=pie].marker
Type: data arraySets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
- line
Parent:data[type=pie].marker
Type: object containing one or more of the keys listed below.- color
Parent:data[type=pie].marker.line
Type: color or array of colors
Default:"#444"Sets the color of the line enclosing each sector.
- width
Parent:data[type=pie].marker.line
Type: number or array of numbers greater than or equal to 0
Default:0Sets the width (in px) of the line enclosing each sector.
- color
- pattern
Parent:data[type=pie].marker
Type: object containing one or more of the keys listed below.Sets the pattern within the marker.
- bgcolor
Parent:data[type=pie].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is "overlay". Otherwise, defaults to a transparent background.
- fgcolor
Parent:data[type=pie].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is "replace". Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.
- fgopacity
Parent:data[type=pie].marker.pattern
Type: number between or equal to 0 and 1Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
- fillmode
Parent:data[type=pie].marker.pattern
Type: enumerated , one of ("replace"|"overlay")
Default:"replace"Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.
- path
Parent:data[type=pie].marker.pattern
Type: string or array of stringsSets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.
- shape
Parent:data[type=pie].marker.pattern
Type: enumerated or array of enumerateds , one of (""|"/"|"\"|"x"|"-"|"|"|"+"|".")
Default:""Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- size
Parent:data[type=pie].marker.pattern
Type: number or array of numbers greater than or equal to 0
Default:8Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- solidity
Parent:data[type=pie].marker.pattern
Type: number or array of numbers between or equal to 0 and 1
Default:0.3Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- bgcolor
- colors
- textfont
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.Sets the font used for `textinfo`.
- color
Parent:data[type=pie].textfont
Type: color or array of colors - family
Parent:data[type=pie].textfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=pie].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=pie].textfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=pie].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=pie].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=pie].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=pie].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=pie].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- textinfo
Parent:data[type=pie]
Type: flaglist string. Any combination of"label","text","value","percent"joined with a"+"OR"none".
Examples:"label","text","label+text","label+text+value","none"Determines which trace information appear on the graph.
- direction
Parent:data[type=pie]
Type: enumerated , one of ("clockwise"|"counterclockwise")
Default:"counterclockwise"Specifies the direction at which succeeding sectors follow one another.
- hole
Parent:data[type=pie]
Type: number between or equal to 0 and 1
Default:0Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
- hoverlabel
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=pie].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=pie].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=pie].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=pie].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=pie].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=pie].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=pie].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=pie].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=pie].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=pie].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=pie].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=pie].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=pie].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=pie].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=pie].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- insidetextfont
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.Sets the font used for `textinfo` lying inside the sector.
- color
Parent:data[type=pie].insidetextfont
Type: color or array of colors - family
Parent:data[type=pie].insidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=pie].insidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=pie].insidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=pie].insidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=pie].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=pie].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=pie].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=pie].insidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- insidetextorientation
Parent:data[type=pie]
Type: enumerated , one of ("horizontal"|"radial"|"tangential"|"auto")
Default:"auto"Controls the orientation of the text inside chart sectors. When set to "auto", text may be oriented in any direction in order to be as big as possible in the middle of a sector. The "horizontal" option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The "radial" option orients text along the radius of the sector. The "tangential" option orients text perpendicular to the radius of the sector.
- outsidetextfont
Parent:data[type=pie]
Type: object containing one or more of the keys listed below.Sets the font used for `textinfo` lying outside the sector.
- color
Parent:data[type=pie].outsidetextfont
Type: color or array of colors - family
Parent:data[type=pie].outsidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=pie].outsidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=pie].outsidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=pie].outsidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=pie].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=pie].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=pie].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=pie].outsidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- rotation
Parent:data[type=pie]
Type: angle
Default:0Instead of the first slice starting at 12 o'clock, rotate to some other angle.
- scalegroup
Parent:data[type=pie]
Type: string
Default:""If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
- sort
Parent:data[type=pie]
Type: boolean
Default:trueDetermines whether or not the sectors are reordered from largest to smallest.
- uirevision
Parent:data[type=pie]
Type: number or categorical coordinate stringControls 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.
heatmap traces
heatmap trace is an object with the key "type" equal to "heatmap" (i.e. {"type": "heatmap"}) and any of the keys listed below. The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a 2D array of values (ragged or not) or a 1D array of values. In the case where `z` is a 2D array, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D array, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets.
- type
Parent:data[type=heatmap]
Type: "heatmap" - name
Parent:data[type=heatmap]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=heatmap]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=heatmap]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=heatmap]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=heatmap]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=heatmap]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=heatmap]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=heatmap].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=heatmap].legendgrouptitle.font
Type: color - family
Parent:data[type=heatmap].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=heatmap].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=heatmap].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=heatmap].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=heatmap].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=heatmap].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=heatmap].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=heatmap].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=heatmap].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=heatmap]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=heatmap]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=heatmap]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=heatmap]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=heatmap]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=heatmap]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=heatmap]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- xtype
Parent:data[type=heatmap]
Type: enumerated , one of ("array"|"scaled")If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).
- xgap
Parent:data[type=heatmap]
Type: number greater than or equal to 0
Default:0Sets the horizontal gap (in pixels) between bricks.
- y
Parent:data[type=heatmap]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=heatmap]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=heatmap]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- ytype
Parent:data[type=heatmap]
Type: enumerated , one of ("array"|"scaled")If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)
- ygap
Parent:data[type=heatmap]
Type: number greater than or equal to 0
Default:0Sets the vertical gap (in pixels) between bricks.
- z
Parent:data[type=heatmap]
Type: data arraySets the z data.
- text
Parent:data[type=heatmap]
Type: data arraySets the text elements associated with each z value.
- texttemplate
Parent:data[type=heatmap]
Type: string
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.
- texttemplatefallback
Parent:data[type=heatmap]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=heatmap]
Type: data arraySame as `text`.
- hoverinfo
Parent:data[type=heatmap]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=heatmap]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=heatmap]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=heatmap]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=heatmap]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=heatmap]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=heatmap]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=heatmap]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=heatmap]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- coloraxis
Parent:data[type=heatmap]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- xperiod
Parent:data[type=heatmap]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=heatmap]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=heatmap]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=heatmap]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=heatmap]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=heatmap]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- textfont
Parent:data[type=heatmap]
Type: object containing one or more of the keys listed below.Sets the text font.
- color
Parent:data[type=heatmap].textfont
Type: color
Default:"auto" - family
Parent:data[type=heatmap].textfont
Type: stringHTML 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.
- lineposition
Parent:data[type=heatmap].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=heatmap].textfont
Type: string
Default:"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.
- size
Parent:data[type=heatmap].textfont
Type: number greater than or equal to 1
Default:"auto" - style
Parent:data[type=heatmap].textfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=heatmap].textfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=heatmap].textfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=heatmap].textfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- colorbar
Parent:data[type=heatmap]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=heatmap].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=heatmap].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=heatmap].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=heatmap].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=heatmap].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=heatmap].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=heatmap].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=heatmap].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=heatmap].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=heatmap].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=heatmap].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=heatmap].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=heatmap].colorbar.tickfont
Type: color - family
Parent:data[type=heatmap].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=heatmap].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=heatmap].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=heatmap].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=heatmap].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=heatmap].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=heatmap].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=heatmap].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=heatmap].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=heatmap].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=heatmap].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=heatmap].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=heatmap].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=heatmap].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=heatmap].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=heatmap].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=heatmap].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=heatmap].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=heatmap].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=heatmap].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=heatmap].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=heatmap].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=heatmap].colorbar.title.font
Type: color - family
Parent:data[type=heatmap].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=heatmap].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=heatmap].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=heatmap].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=heatmap].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=heatmap].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=heatmap].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=heatmap].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=heatmap].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=heatmap].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=heatmap].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=heatmap].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=heatmap].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=heatmap].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=heatmap]
Type: booleanDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=heatmap]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=heatmap]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=heatmap]
Type: booleanReverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
- zauto
Parent:data[type=heatmap]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.
- zhoverformat
Parent:data[type=heatmap]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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.By default the values are formatted using generic number format.
- zmax
Parent:data[type=heatmap]
Type: numberSets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
- zmid
Parent:data[type=heatmap]
Type: numberSets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.
- zmin
Parent:data[type=heatmap]
Type: numberSets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
- zsmooth
Parent:data[type=heatmap]
Type: enumerated , one of ("fast"|"best"|false)Picks a smoothing algorithm use to smooth `z` data.
- connectgaps
Parent:data[type=heatmap]
Type: booleanDetermines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false.
- hoverlabel
Parent:data[type=heatmap]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=heatmap].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=heatmap].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=heatmap].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=heatmap].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=heatmap].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=heatmap].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=heatmap].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=heatmap].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=heatmap].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=heatmap].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=heatmap].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=heatmap].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=heatmap].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=heatmap].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=heatmap].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- hoverongaps
Parent:data[type=heatmap]
Type: boolean
Default:trueDetermines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.
- transpose
Parent:data[type=heatmap]
Type: booleanTransposes the z data.
- xcalendar
Parent:data[type=heatmap]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=heatmap]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=heatmap]
Type: number or categorical coordinate stringControls 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.
image traces
image trace is an object with the key "type" equal to "image" (i.e. {"type": "image"}) and any of the keys listed below. Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. `autorange: 'reversed'`), constrained to the domain (ie. `constrain: 'domain'`) and it will have the same scale as its x axis (ie. `scaleanchor: 'x,`) in order for pixels to be rendered as squares.
- type
Parent:data[type=image]
Type: "image" - name
Parent:data[type=image]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=image]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- legend
Parent:data[type=image]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=image]
Type: number
Default:1000Sets 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.
- legendgrouptitle
Parent:data[type=image]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=image].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=image].legendgrouptitle.font
Type: color - family
Parent:data[type=image].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=image].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=image].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=image].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=image].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=image].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=image].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=image].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=image].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=image]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=image]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=image]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=image]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x0
Parent:data[type=image]
Type: number or categorical coordinate string
Default:0Set the image's x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2
- dx
Parent:data[type=image]
Type: number
Default:1Set the pixel's horizontal size.
- y0
Parent:data[type=image]
Type: number or categorical coordinate string
Default:0Set the image's y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.
- dy
Parent:data[type=image]
Type: number
Default:1Set the pixel's vertical size
- z
Parent:data[type=image]
Type: data arrayA 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.
- source
Parent:data[type=image]
Type: stringSpecifies the data URI of the image to be visualized. The URI consists of "data:image/[<media subtype\\>][;base64\\],<data\\>"
- text
Parent:data[type=image]
Type: data arraySets the text elements associated with each z value.
- hovertext
Parent:data[type=image]
Type: data arraySame as `text`.
- hoverinfo
Parent:data[type=image]
Type: flaglist string. Any combination of"x","y","z","color","name","text"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"x+y+z+text+name"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=image]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `z`, `color` and `colormodel`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=image]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- meta
Parent:data[type=image]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=image]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=image]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=image]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- colormodel
Parent:data[type=image]
Type: enumerated , one of ("rgb"|"rgba"|"rgba256"|"hsl"|"hsla")Color model used to map the numerical color components described in `z` into colors. If `source` is specified, this attribute will be set to `rgba256` otherwise it defaults to `rgb`.
- zmax
Parent:data[type=image]
Type: arrayArray defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `rgba256` colormodel, it is [255, 255, 255, 255]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1].
- zmin
Parent:data[type=image]
Type: arrayArray defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0].
- zsmooth
Parent:data[type=image]
Type: enumerated , one of ("fast"|false)Picks a smoothing algorithm used to smooth `z` data. This only applies for image traces that use the `source` attribute.
- hoverlabel
Parent:data[type=image]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=image].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=image].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=image].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=image].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=image].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=image].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=image].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=image].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=image].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=image].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=image].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=image].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=image].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=image].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=image].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- uirevision
Parent:data[type=image]
Type: number or categorical coordinate stringControls 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.
contour traces
contour trace is an object with the key "type" equal to "contour" (i.e. {"type": "contour"}) and any of the keys listed below. The data from which contour lines are computed is set in `z`. Data in `z` must be a 2D array of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to "true", the above behavior is flipped.
- type
Parent:data[type=contour]
Type: "contour" - name
Parent:data[type=contour]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=contour]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=contour]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=contour]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=contour]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=contour]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=contour]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=contour].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=contour].legendgrouptitle.font
Type: color - family
Parent:data[type=contour].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=contour].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=contour].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=contour].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=contour].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=contour].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=contour].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=contour].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=contour].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=contour]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=contour]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=contour]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=contour]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=contour]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=contour]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=contour]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- xtype
Parent:data[type=contour]
Type: enumerated , one of ("array"|"scaled")If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).
- y
Parent:data[type=contour]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=contour]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=contour]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- ytype
Parent:data[type=contour]
Type: enumerated , one of ("array"|"scaled")If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)
- z
Parent:data[type=contour]
Type: data arraySets the z data.
- text
Parent:data[type=contour]
Type: data arraySets the text elements associated with each z value.
- texttemplate
Parent:data[type=contour]
Type: string
Default:""For this trace it only has an effect if `coloring` is set to "heatmap". Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.
- texttemplatefallback
Parent:data[type=contour]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=contour]
Type: data arraySame as `text`.
- hoverinfo
Parent:data[type=contour]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=contour]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=contour]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=contour]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=contour]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=contour]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=contour]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=contour]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=contour]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- coloraxis
Parent:data[type=contour]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- xperiod
Parent:data[type=contour]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=contour]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=contour]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=contour]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=contour]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=contour]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- line
Parent:data[type=contour]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=contour].line
Type: colorSets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".
- dash
Parent:data[type=contour].line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- smoothing
Parent:data[type=contour].line
Type: number between or equal to 0 and 1.3
Default:1Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.
- width
Parent:data[type=contour].line
Type: number greater than or equal to 0Sets the contour line width in (in px) Defaults to "0.5" when `contours.type` is "levels". Defaults to "2" when `contour.type` is "constraint".
- color
- textfont
Parent:data[type=contour]
Type: object containing one or more of the keys listed below.For this trace it only has an effect if `coloring` is set to "heatmap". Sets the text font.
- color
Parent:data[type=contour].textfont
Type: color
Default:"auto" - family
Parent:data[type=contour].textfont
Type: stringHTML 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.
- lineposition
Parent:data[type=contour].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=contour].textfont
Type: string
Default:"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.
- size
Parent:data[type=contour].textfont
Type: number greater than or equal to 1
Default:"auto" - style
Parent:data[type=contour].textfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=contour].textfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=contour].textfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=contour].textfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- colorbar
Parent:data[type=contour]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=contour].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=contour].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=contour].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=contour].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=contour].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=contour].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=contour].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=contour].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=contour].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=contour].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=contour].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=contour].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=contour].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=contour].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=contour].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=contour].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=contour].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=contour].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=contour].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=contour].colorbar.tickfont
Type: color - family
Parent:data[type=contour].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=contour].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=contour].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=contour].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=contour].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=contour].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=contour].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=contour].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=contour].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=contour].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=contour].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=contour].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=contour].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=contour].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=contour].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=contour].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=contour].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=contour].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=contour].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=contour].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=contour].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=contour].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=contour].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=contour].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=contour].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=contour].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=contour].colorbar.title.font
Type: color - family
Parent:data[type=contour].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=contour].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=contour].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=contour].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=contour].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=contour].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=contour].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=contour].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=contour].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=contour].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=contour].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=contour].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=contour].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=contour].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=contour].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=contour].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=contour].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=contour]
Type: booleanDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=contour]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=contour]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=contour]
Type: booleanReverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
- zauto
Parent:data[type=contour]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.
- zhoverformat
Parent:data[type=contour]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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.By default the values are formatted using generic number format.
- zmax
Parent:data[type=contour]
Type: numberSets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
- zmid
Parent:data[type=contour]
Type: numberSets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.
- zmin
Parent:data[type=contour]
Type: numberSets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
- autocontour
Parent:data[type=contour]
Type: boolean
Default:trueDetermines whether or not the contour level attributes are picked by an algorithm. If "true", the number of contour levels can be set in `ncontours`. If "false", set the contour level attributes in `contours`.
- connectgaps
Parent:data[type=contour]
Type: booleanDetermines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false.
- contours
Parent:data[type=contour]
Type: object containing one or more of the keys listed below.- coloring
Parent:data[type=contour].contours
Type: enumerated , one of ("fill"|"heatmap"|"lines"|"none")
Default:"fill"Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.
- end
Parent:data[type=contour].contours
Type: numberSets the end contour level value. Must be more than `contours.start`
- labelfont
Parent:data[type=contour].contours
Type: object containing one or more of the keys listed below.Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.
- color
Parent:data[type=contour].contours.labelfont
Type: color - family
Parent:data[type=contour].contours.labelfont
Type: stringHTML 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.
- lineposition
Parent:data[type=contour].contours.labelfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=contour].contours.labelfont
Type: string
Default:"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.
- size
Parent:data[type=contour].contours.labelfont
Type: number greater than or equal to 1 - style
Parent:data[type=contour].contours.labelfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=contour].contours.labelfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=contour].contours.labelfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=contour].contours.labelfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- labelformat
Parent:data[type=contour].contours
Type: string
Default:""Sets the contour 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.
- operation
Parent:data[type=contour].contours
Type: enumerated , one of ("="|"<"|">="|">"|"<="|"[]"|"()"|"[)"|"(]"|"]["|")("|"]("|")[")
Default:"="Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.
- showlabels
Parent:data[type=contour].contours
Type: booleanDetermines whether to label the contour lines with their values.
- showlines
Parent:data[type=contour].contours
Type: boolean
Default:trueDetermines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
- size
Parent:data[type=contour].contours
Type: number greater than or equal to 0Sets the step between each contour level. Must be positive.
- start
Parent:data[type=contour].contours
Type: numberSets the starting contour level value. Must be less than `contours.end`
- type
Parent:data[type=contour].contours
Type: enumerated , one of ("levels"|"constraint")
Default:"levels"If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.
- value
Parent:data[type=contour].contours
Type: number or categorical coordinate string
Default:0Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (`=,<,>=,>,<=`) "value" is expected to be a number. When `operation` is set to one of the interval values (`[],(),[),(],][,)(,](,)[`) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
- coloring
- fillcolor
Parent:data[type=contour]
Type: colorSets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- hoverlabel
Parent:data[type=contour]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=contour].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=contour].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=contour].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=contour].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=contour].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=contour].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=contour].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=contour].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=contour].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=contour].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=contour].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=contour].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=contour].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=contour].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=contour].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- hoverongaps
Parent:data[type=contour]
Type: boolean
Default:trueDetermines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.
- ncontours
Parent:data[type=contour]
Type: integer greater than or equal to 1
Default:15Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "true" or if `contours.size` is missing.
- transpose
Parent:data[type=contour]
Type: booleanTransposes the z data.
- xcalendar
Parent:data[type=contour]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=contour]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=contour]
Type: number or categorical coordinate stringControls 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.
table traces
table trace is an object with the key "type" equal to "table" (i.e. {"type": "table"}) and any of the keys listed below. Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column-major order, ie. the grid is represented as a vector of column vectors.
- type
Parent:data[type=table]
Type: "table" - name
Parent:data[type=table]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=table]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- legend
Parent:data[type=table]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=table]
Type: number
Default:1000Sets 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.
- legendgrouptitle
Parent:data[type=table]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=table].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=table].legendgrouptitle.font
Type: color - family
Parent:data[type=table].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=table].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=table].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=table].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=table].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=table].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=table].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=table]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- ids
Parent:data[type=table]
Type: data arrayAssigns 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.
- columnorder
Parent:data[type=table]
Type: data arraySpecifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero.
- columnwidth
Parent:data[type=table]
Type: number or array of numbersThe width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
- hoverinfo
Parent:data[type=table]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- meta
Parent:data[type=table]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=table]
Type: data arrayAssigns 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
- domain
Parent:data[type=table]
Type: object containing one or more of the keys listed below.- column
Parent:data[type=table].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this column in the grid for this table trace .
- row
Parent:data[type=table].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this row in the grid for this table trace .
- x
Parent:data[type=table].domain
Type: array
Default:[0, 1]Sets the horizontal domain of this table trace (in plot fraction).
- y
Parent:data[type=table].domain
Type: array
Default:[0, 1]Sets the vertical domain of this table trace (in plot fraction).
- column
- cells
Parent:data[type=table]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=table].cells
Type: enumerated or array of enumerateds , one of ("left"|"center"|"right")
Default:"center"Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.
- fill
Parent:data[type=table].cells
Type: object containing one or more of the keys listed below.- color
Parent:data[type=table].cells.fill
Type: color or array of colors
Default:"white"Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.
- color
- font
Parent:data[type=table].cells
Type: object containing one or more of the keys listed below.- color
Parent:data[type=table].cells.font
Type: color or array of colors - family
Parent:data[type=table].cells.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=table].cells.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=table].cells.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=table].cells.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=table].cells.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].cells.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].cells.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=table].cells.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- format
Parent:data[type=table].cells
Type: data array
Default:Sets the cell 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.
- height
Parent:data[type=table].cells
Type: number
Default:20The height of cells.
- line
Parent:data[type=table].cells
Type: object containing one or more of the keys listed below. - prefix
Parent:data[type=table].cells
Type: string or array of stringsPrefix for cell values.
- suffix
Parent:data[type=table].cells
Type: string or array of stringsSuffix for cell values.
- values
Parent:data[type=table].cells
Type: data array
Default:Cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.
- align
- header
Parent:data[type=table]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=table].header
Type: enumerated or array of enumerateds , one of ("left"|"center"|"right")
Default:"center"Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.
- fill
Parent:data[type=table].header
Type: object containing one or more of the keys listed below.- color
Parent:data[type=table].header.fill
Type: color or array of colors
Default:"white"Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.
- color
- font
Parent:data[type=table].header
Type: object containing one or more of the keys listed below.- color
Parent:data[type=table].header.font
Type: color or array of colors - family
Parent:data[type=table].header.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=table].header.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=table].header.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=table].header.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=table].header.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].header.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].header.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=table].header.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- format
Parent:data[type=table].header
Type: data array
Default:Sets the cell 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.
- height
Parent:data[type=table].header
Type: number
Default:28The height of cells.
- line
Parent:data[type=table].header
Type: object containing one or more of the keys listed below. - prefix
Parent:data[type=table].header
Type: string or array of stringsPrefix for cell values.
- suffix
Parent:data[type=table].header
Type: string or array of stringsSuffix for cell values.
- values
Parent:data[type=table].header
Type: data array
Default:Header cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.
- align
- hoverlabel
Parent:data[type=table]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=table].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=table].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=table].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=table].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=table].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=table].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=table].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=table].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=table].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=table].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=table].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=table].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=table].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- uirevision
Parent:data[type=table]
Type: number or categorical coordinate stringControls 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.
box traces
box trace is an object with the key "type" equal to "box" (i.e. {"type": "box"}) and any of the keys listed below. Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes' edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the `y` data array for vertical boxes (`x` for horizontal boxes). By supplying an `x` (`y`) array, one box per distinct `x` (`y`) value is drawn If no `x` (`y`) array is provided, a single box is drawn. In this case, the box is positioned with the trace `name` or with `x0` (`y0`) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the `q1`, `median` and `q3` data arrays respectively. Other box features relying on statistics namely `lowerfence`, `upperfence`, `notchspan` can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the `y` data array for vertical boxes (`x` for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size.
- type
Parent:data[type=box]
Type: "box" - name
Parent:data[type=box]
Type: stringSets the trace name. The trace name appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical
- visible
Parent:data[type=box]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=box]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=box]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=box]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=box]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=box]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=box].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=box].legendgrouptitle.font
Type: color - family
Parent:data[type=box].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=box].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=box].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=box].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=box].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=box].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=box].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=box].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=box].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=box]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=box]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=box]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=box]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=box]
Type: data arraySets the x sample data or coordinates. See overview for more info.
- x0
Parent:data[type=box]
Type: number or categorical coordinate stringSets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
- dx
Parent:data[type=box]
Type: numberSets the x coordinate step for multi-box traces set using q1/median/q3.
- y
Parent:data[type=box]
Type: data arraySets the y sample data or coordinates. See overview for more info.
- y0
Parent:data[type=box]
Type: number or categorical coordinate stringSets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
- dy
Parent:data[type=box]
Type: numberSets the y coordinate step for multi-box traces set using q1/median/q3.
- width
Parent:data[type=box]
Type: number greater than or equal to 0
Default:0Sets the width of the box in data coordinate If "0" (default value) the width is automatically selected based on the positions of other box traces in the same subplot.
- text
Parent:data[type=box]
Type: string or array of strings
Default:""Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hovertext
Parent:data[type=box]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=box]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=box]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=box]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=box]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=box]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=box]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=box]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=box]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=box]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=box]
Type: enumerated , one of ("v"|"h")Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
- alignmentgroup
Parent:data[type=box]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=box]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- xperiod
Parent:data[type=box]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=box]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=box]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=box]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=box]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=box]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- marker
Parent:data[type=box]
Type: object containing one or more of the keys listed below.- angle
Parent:data[type=box].marker
Type: angle
Default:0Sets the marker angle in respect to `angleref`.
- color
Parent:data[type=box].marker
Type: colorSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- line
Parent:data[type=box].marker
Type: object containing one or more of the keys listed below.- color
Parent:data[type=box].marker.line
Type: color
Default:"#444"Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- outliercolor
Parent:data[type=box].marker.line
Type: colorSets the border line color of the outlier sample points. Defaults to marker.color
- outlierwidth
Parent:data[type=box].marker.line
Type: number greater than or equal to 0
Default:1Sets the border line width (in px) of the outlier sample points.
- width
Parent:data[type=box].marker.line
Type: number greater than or equal to 0
Default:0Sets the width (in px) of the lines bounding the marker points.
- color
- opacity
Parent:data[type=box].marker
Type: number between or equal to 0 and 1
Default:1Sets the marker opacity.
- outliercolor
Parent:data[type=box].marker
Type: color
Default:"rgba(0, 0, 0, 0)"Sets the color of the outlier sample points.
- size
Parent:data[type=box].marker
Type: number greater than or equal to 0
Default:6Sets the marker size (in px).
- symbol
Parent:data[type=box].marker
Type: enumerated , one of ("0"|"0"|"circle"|"100"|"100"|"circle-open"|"200"|"200"|"circle-dot"|"300"|"300"|"circle-open-dot"|"1"|"1"|"square"|"101"|"101"|"square-open"|"201"|"201"|"square-dot"|"301"|"301"|"square-open-dot"|"2"|"2"|"diamond"|"102"|"102"|"diamond-open"|"202"|"202"|"diamond-dot"|"302"|"302"|"diamond-open-dot"|"3"|"3"|"cross"|"103"|"103"|"cross-open"|"203"|"203"|"cross-dot"|"303"|"303"|"cross-open-dot"|"4"|"4"|"x"|"104"|"104"|"x-open"|"204"|"204"|"x-dot"|"304"|"304"|"x-open-dot"|"5"|"5"|"triangle-up"|"105"|"105"|"triangle-up-open"|"205"|"205"|"triangle-up-dot"|"305"|"305"|"triangle-up-open-dot"|"6"|"6"|"triangle-down"|"106"|"106"|"triangle-down-open"|"206"|"206"|"triangle-down-dot"|"306"|"306"|"triangle-down-open-dot"|"7"|"7"|"triangle-left"|"107"|"107"|"triangle-left-open"|"207"|"207"|"triangle-left-dot"|"307"|"307"|"triangle-left-open-dot"|"8"|"8"|"triangle-right"|"108"|"108"|"triangle-right-open"|"208"|"208"|"triangle-right-dot"|"308"|"308"|"triangle-right-open-dot"|"9"|"9"|"triangle-ne"|"109"|"109"|"triangle-ne-open"|"209"|"209"|"triangle-ne-dot"|"309"|"309"|"triangle-ne-open-dot"|"10"|"10"|"triangle-se"|"110"|"110"|"triangle-se-open"|"210"|"210"|"triangle-se-dot"|"310"|"310"|"triangle-se-open-dot"|"11"|"11"|"triangle-sw"|"111"|"111"|"triangle-sw-open"|"211"|"211"|"triangle-sw-dot"|"311"|"311"|"triangle-sw-open-dot"|"12"|"12"|"triangle-nw"|"112"|"112"|"triangle-nw-open"|"212"|"212"|"triangle-nw-dot"|"312"|"312"|"triangle-nw-open-dot"|"13"|"13"|"pentagon"|"113"|"113"|"pentagon-open"|"213"|"213"|"pentagon-dot"|"313"|"313"|"pentagon-open-dot"|"14"|"14"|"hexagon"|"114"|"114"|"hexagon-open"|"214"|"214"|"hexagon-dot"|"314"|"314"|"hexagon-open-dot"|"15"|"15"|"hexagon2"|"115"|"115"|"hexagon2-open"|"215"|"215"|"hexagon2-dot"|"315"|"315"|"hexagon2-open-dot"|"16"|"16"|"octagon"|"116"|"116"|"octagon-open"|"216"|"216"|"octagon-dot"|"316"|"316"|"octagon-open-dot"|"17"|"17"|"star"|"117"|"117"|"star-open"|"217"|"217"|"star-dot"|"317"|"317"|"star-open-dot"|"18"|"18"|"hexagram"|"118"|"118"|"hexagram-open"|"218"|"218"|"hexagram-dot"|"318"|"318"|"hexagram-open-dot"|"19"|"19"|"star-triangle-up"|"119"|"119"|"star-triangle-up-open"|"219"|"219"|"star-triangle-up-dot"|"319"|"319"|"star-triangle-up-open-dot"|"20"|"20"|"star-triangle-down"|"120"|"120"|"star-triangle-down-open"|"220"|"220"|"star-triangle-down-dot"|"320"|"320"|"star-triangle-down-open-dot"|"21"|"21"|"star-square"|"121"|"121"|"star-square-open"|"221"|"221"|"star-square-dot"|"321"|"321"|"star-square-open-dot"|"22"|"22"|"star-diamond"|"122"|"122"|"star-diamond-open"|"222"|"222"|"star-diamond-dot"|"322"|"322"|"star-diamond-open-dot"|"23"|"23"|"diamond-tall"|"123"|"123"|"diamond-tall-open"|"223"|"223"|"diamond-tall-dot"|"323"|"323"|"diamond-tall-open-dot"|"24"|"24"|"diamond-wide"|"124"|"124"|"diamond-wide-open"|"224"|"224"|"diamond-wide-dot"|"324"|"324"|"diamond-wide-open-dot"|"25"|"25"|"hourglass"|"125"|"125"|"hourglass-open"|"26"|"26"|"bowtie"|"126"|"126"|"bowtie-open"|"27"|"27"|"circle-cross"|"127"|"127"|"circle-cross-open"|"28"|"28"|"circle-x"|"128"|"128"|"circle-x-open"|"29"|"29"|"square-cross"|"129"|"129"|"square-cross-open"|"30"|"30"|"square-x"|"130"|"130"|"square-x-open"|"31"|"31"|"diamond-cross"|"131"|"131"|"diamond-cross-open"|"32"|"32"|"diamond-x"|"132"|"132"|"diamond-x-open"|"33"|"33"|"cross-thin"|"133"|"133"|"cross-thin-open"|"34"|"34"|"x-thin"|"134"|"134"|"x-thin-open"|"35"|"35"|"asterisk"|"135"|"135"|"asterisk-open"|"36"|"36"|"hash"|"136"|"136"|"hash-open"|"236"|"236"|"hash-dot"|"336"|"336"|"hash-open-dot"|"37"|"37"|"y-up"|"137"|"137"|"y-up-open"|"38"|"38"|"y-down"|"138"|"138"|"y-down-open"|"39"|"39"|"y-left"|"139"|"139"|"y-left-open"|"40"|"40"|"y-right"|"140"|"140"|"y-right-open"|"41"|"41"|"line-ew"|"141"|"141"|"line-ew-open"|"42"|"42"|"line-ns"|"142"|"142"|"line-ns-open"|"43"|"43"|"line-ne"|"143"|"143"|"line-ne-open"|"44"|"44"|"line-nw"|"144"|"144"|"line-nw-open"|"45"|"45"|"arrow-up"|"145"|"145"|"arrow-up-open"|"46"|"46"|"arrow-down"|"146"|"146"|"arrow-down-open"|"47"|"47"|"arrow-left"|"147"|"147"|"arrow-left-open"|"48"|"48"|"arrow-right"|"148"|"148"|"arrow-right-open"|"49"|"49"|"arrow-bar-up"|"149"|"149"|"arrow-bar-up-open"|"50"|"50"|"arrow-bar-down"|"150"|"150"|"arrow-bar-down-open"|"51"|"51"|"arrow-bar-left"|"151"|"151"|"arrow-bar-left-open"|"52"|"52"|"arrow-bar-right"|"152"|"152"|"arrow-bar-right-open"|"53"|"53"|"arrow"|"153"|"153"|"arrow-open"|"54"|"54"|"arrow-wide"|"154"|"154"|"arrow-wide-open")
Default:"circle"Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
- angle
- line
Parent:data[type=box]
Type: object containing one or more of the keys listed below. - boxmean
Parent:data[type=box]
Type: enumerated , one of (true|"sd"|false)If "true", the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to "true" when `mean` is set. Defaults to "sd" when `sd` is set Otherwise defaults to "false".
- boxpoints
Parent:data[type=box]
Type: enumerated , one of ("all"|"outliers"|"suspectedoutliers"|false)If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If "false", only the box(es) are shown with no sample points Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers".
- notched
Parent:data[type=box]
Type: booleanDetermines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 " IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to "false" unless `notchwidth` or `notchspan` is set.
- notchwidth
Parent:data[type=box]
Type: number between or equal to 0 and 0.5
Default:0.25Sets the width of the notches relative to the box width. For example, with 0, the notches are as wide as the box(es).
- showwhiskers
Parent:data[type=box]
Type: booleanDetermines whether or not whiskers are visible. Defaults to true for `sizemode` "quartiles", false for "sd".
- whiskerwidth
Parent:data[type=box]
Type: number between or equal to 0 and 1
Default:0.5Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).
- q1
Parent:data[type=box]
Type: data arraySets the Quartile 1 values. There should be as many items as the number of boxes desired.
- median
Parent:data[type=box]
Type: data arraySets the median values. There should be as many items as the number of boxes desired.
- q3
Parent:data[type=box]
Type: data arraySets the Quartile 3 values. There should be as many items as the number of boxes desired.
- lowerfence
Parent:data[type=box]
Type: data arraySets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR.
- upperfence
Parent:data[type=box]
Type: data arraySets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the upper as the last sample point above 1.5 times the IQR.
- notchspan
Parent:data[type=box]
Type: data arraySets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 " IQR / sqrt(N), where N is the sample size.
- mean
Parent:data[type=box]
Type: data arraySets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values.
- sd
Parent:data[type=box]
Type: data arraySets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values.
- sdmultiple
Parent:data[type=box]
Type: number greater than or equal to 0
Default:1Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev
- quartilemethod
Parent:data[type=box]
Type: enumerated , one of ("linear"|"exclusive"|"inclusive")
Default:"linear"Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
- selectedpoints
Parent:data[type=box]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- selected
Parent:data[type=box]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=box].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=box].selected.marker
Type: colorSets the marker color of selected points.
- opacity
Parent:data[type=box].selected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of selected points.
- size
Parent:data[type=box].selected.marker
Type: number greater than or equal to 0Sets the marker size of selected points.
- color
- marker
- unselected
Parent:data[type=box]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=box].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=box].unselected.marker
Type: colorSets the marker color of unselected points, applied only when a selection exists.
- opacity
Parent:data[type=box].unselected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of unselected points, applied only when a selection exists.
- size
Parent:data[type=box].unselected.marker
Type: number greater than or equal to 0Sets the marker size of unselected points, applied only when a selection exists.
- color
- marker
- fillcolor
Parent:data[type=box]
Type: colorSets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- hoverlabel
Parent:data[type=box]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=box].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=box].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=box].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=box].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=box].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=box].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=box].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=box].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=box].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=box].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=box].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=box].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=box].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=box].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=box].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- hoveron
Parent:data[type=box]
Type: flaglist string. Any combination of"boxes","points"joined with a"+"
Examples:"boxes","points","boxes+points"
Default:"boxes+points"Do the hover effects highlight individual boxes or sample points or both?
- pointpos
Parent:data[type=box]
Type: number between or equal to -2 and 2Sets the position of the sample points in relation to the box(es). If "0", the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
- jitter
Parent:data[type=box]
Type: number between or equal to 0 and 1Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the box(es).
- sizemode
Parent:data[type=box]
Type: enumerated , one of ("quartiles"|"sd")
Default:"quartiles"Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc
- xcalendar
Parent:data[type=box]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=box]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=box]
Type: number or categorical coordinate stringControls 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.
violin traces
violin trace is an object with the key "type" equal to "violin" (i.e. {"type": "violin"}) and any of the keys listed below. In vertical (horizontal) violin plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one violin per distinct x (y) value is drawn If no `x` (`y`) array is provided, a single violin is drawn. That violin position is then positioned with with `name` or with `x0` (`y0`) if provided.
- type
Parent:data[type=violin]
Type: "violin" - name
Parent:data[type=violin]
Type: stringSets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).
- visible
Parent:data[type=violin]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=violin]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=violin]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=violin]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=violin]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=violin].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=violin].legendgrouptitle.font
Type: color - family
Parent:data[type=violin].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=violin].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=violin].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=violin].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=violin].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=violin].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=violin].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=violin].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=violin].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=violin]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=violin]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=violin]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=violin]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=violin]
Type: data arraySets the x sample data or coordinates. See overview for more info.
- x0
Parent:data[type=violin]
Type: number or categorical coordinate stringSets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
- y
Parent:data[type=violin]
Type: data arraySets the y sample data or coordinates. See overview for more info.
- y0
Parent:data[type=violin]
Type: number or categorical coordinate stringSets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
- width
Parent:data[type=violin]
Type: number greater than or equal to 0
Default:0Sets the width of the violin in data coordinates. If "0" (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.
- text
Parent:data[type=violin]
Type: string or array of strings
Default:""Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hovertext
Parent:data[type=violin]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=violin]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=violin]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=violin]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=violin]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=violin]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=violin]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=violin]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=violin]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=violin]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=violin]
Type: enumerated , one of ("v"|"h")Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
- alignmentgroup
Parent:data[type=violin]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=violin]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- marker
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- angle
Parent:data[type=violin].marker
Type: angle
Default:0Sets the marker angle in respect to `angleref`.
- color
Parent:data[type=violin].marker
Type: colorSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- line
Parent:data[type=violin].marker
Type: object containing one or more of the keys listed below.- color
Parent:data[type=violin].marker.line
Type: color
Default:"#444"Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- outliercolor
Parent:data[type=violin].marker.line
Type: colorSets the border line color of the outlier sample points. Defaults to marker.color
- outlierwidth
Parent:data[type=violin].marker.line
Type: number greater than or equal to 0
Default:1Sets the border line width (in px) of the outlier sample points.
- width
Parent:data[type=violin].marker.line
Type: number greater than or equal to 0
Default:0Sets the width (in px) of the lines bounding the marker points.
- color
- opacity
Parent:data[type=violin].marker
Type: number between or equal to 0 and 1
Default:1Sets the marker opacity.
- outliercolor
Parent:data[type=violin].marker
Type: color
Default:"rgba(0, 0, 0, 0)"Sets the color of the outlier sample points.
- size
Parent:data[type=violin].marker
Type: number greater than or equal to 0
Default:6Sets the marker size (in px).
- symbol
Parent:data[type=violin].marker
Type: enumerated , one of ("0"|"0"|"circle"|"100"|"100"|"circle-open"|"200"|"200"|"circle-dot"|"300"|"300"|"circle-open-dot"|"1"|"1"|"square"|"101"|"101"|"square-open"|"201"|"201"|"square-dot"|"301"|"301"|"square-open-dot"|"2"|"2"|"diamond"|"102"|"102"|"diamond-open"|"202"|"202"|"diamond-dot"|"302"|"302"|"diamond-open-dot"|"3"|"3"|"cross"|"103"|"103"|"cross-open"|"203"|"203"|"cross-dot"|"303"|"303"|"cross-open-dot"|"4"|"4"|"x"|"104"|"104"|"x-open"|"204"|"204"|"x-dot"|"304"|"304"|"x-open-dot"|"5"|"5"|"triangle-up"|"105"|"105"|"triangle-up-open"|"205"|"205"|"triangle-up-dot"|"305"|"305"|"triangle-up-open-dot"|"6"|"6"|"triangle-down"|"106"|"106"|"triangle-down-open"|"206"|"206"|"triangle-down-dot"|"306"|"306"|"triangle-down-open-dot"|"7"|"7"|"triangle-left"|"107"|"107"|"triangle-left-open"|"207"|"207"|"triangle-left-dot"|"307"|"307"|"triangle-left-open-dot"|"8"|"8"|"triangle-right"|"108"|"108"|"triangle-right-open"|"208"|"208"|"triangle-right-dot"|"308"|"308"|"triangle-right-open-dot"|"9"|"9"|"triangle-ne"|"109"|"109"|"triangle-ne-open"|"209"|"209"|"triangle-ne-dot"|"309"|"309"|"triangle-ne-open-dot"|"10"|"10"|"triangle-se"|"110"|"110"|"triangle-se-open"|"210"|"210"|"triangle-se-dot"|"310"|"310"|"triangle-se-open-dot"|"11"|"11"|"triangle-sw"|"111"|"111"|"triangle-sw-open"|"211"|"211"|"triangle-sw-dot"|"311"|"311"|"triangle-sw-open-dot"|"12"|"12"|"triangle-nw"|"112"|"112"|"triangle-nw-open"|"212"|"212"|"triangle-nw-dot"|"312"|"312"|"triangle-nw-open-dot"|"13"|"13"|"pentagon"|"113"|"113"|"pentagon-open"|"213"|"213"|"pentagon-dot"|"313"|"313"|"pentagon-open-dot"|"14"|"14"|"hexagon"|"114"|"114"|"hexagon-open"|"214"|"214"|"hexagon-dot"|"314"|"314"|"hexagon-open-dot"|"15"|"15"|"hexagon2"|"115"|"115"|"hexagon2-open"|"215"|"215"|"hexagon2-dot"|"315"|"315"|"hexagon2-open-dot"|"16"|"16"|"octagon"|"116"|"116"|"octagon-open"|"216"|"216"|"octagon-dot"|"316"|"316"|"octagon-open-dot"|"17"|"17"|"star"|"117"|"117"|"star-open"|"217"|"217"|"star-dot"|"317"|"317"|"star-open-dot"|"18"|"18"|"hexagram"|"118"|"118"|"hexagram-open"|"218"|"218"|"hexagram-dot"|"318"|"318"|"hexagram-open-dot"|"19"|"19"|"star-triangle-up"|"119"|"119"|"star-triangle-up-open"|"219"|"219"|"star-triangle-up-dot"|"319"|"319"|"star-triangle-up-open-dot"|"20"|"20"|"star-triangle-down"|"120"|"120"|"star-triangle-down-open"|"220"|"220"|"star-triangle-down-dot"|"320"|"320"|"star-triangle-down-open-dot"|"21"|"21"|"star-square"|"121"|"121"|"star-square-open"|"221"|"221"|"star-square-dot"|"321"|"321"|"star-square-open-dot"|"22"|"22"|"star-diamond"|"122"|"122"|"star-diamond-open"|"222"|"222"|"star-diamond-dot"|"322"|"322"|"star-diamond-open-dot"|"23"|"23"|"diamond-tall"|"123"|"123"|"diamond-tall-open"|"223"|"223"|"diamond-tall-dot"|"323"|"323"|"diamond-tall-open-dot"|"24"|"24"|"diamond-wide"|"124"|"124"|"diamond-wide-open"|"224"|"224"|"diamond-wide-dot"|"324"|"324"|"diamond-wide-open-dot"|"25"|"25"|"hourglass"|"125"|"125"|"hourglass-open"|"26"|"26"|"bowtie"|"126"|"126"|"bowtie-open"|"27"|"27"|"circle-cross"|"127"|"127"|"circle-cross-open"|"28"|"28"|"circle-x"|"128"|"128"|"circle-x-open"|"29"|"29"|"square-cross"|"129"|"129"|"square-cross-open"|"30"|"30"|"square-x"|"130"|"130"|"square-x-open"|"31"|"31"|"diamond-cross"|"131"|"131"|"diamond-cross-open"|"32"|"32"|"diamond-x"|"132"|"132"|"diamond-x-open"|"33"|"33"|"cross-thin"|"133"|"133"|"cross-thin-open"|"34"|"34"|"x-thin"|"134"|"134"|"x-thin-open"|"35"|"35"|"asterisk"|"135"|"135"|"asterisk-open"|"36"|"36"|"hash"|"136"|"136"|"hash-open"|"236"|"236"|"hash-dot"|"336"|"336"|"hash-open-dot"|"37"|"37"|"y-up"|"137"|"137"|"y-up-open"|"38"|"38"|"y-down"|"138"|"138"|"y-down-open"|"39"|"39"|"y-left"|"139"|"139"|"y-left-open"|"40"|"40"|"y-right"|"140"|"140"|"y-right-open"|"41"|"41"|"line-ew"|"141"|"141"|"line-ew-open"|"42"|"42"|"line-ns"|"142"|"142"|"line-ns-open"|"43"|"43"|"line-ne"|"143"|"143"|"line-ne-open"|"44"|"44"|"line-nw"|"144"|"144"|"line-nw-open"|"45"|"45"|"arrow-up"|"145"|"145"|"arrow-up-open"|"46"|"46"|"arrow-down"|"146"|"146"|"arrow-down-open"|"47"|"47"|"arrow-left"|"147"|"147"|"arrow-left-open"|"48"|"48"|"arrow-right"|"148"|"148"|"arrow-right-open"|"49"|"49"|"arrow-bar-up"|"149"|"149"|"arrow-bar-up-open"|"50"|"50"|"arrow-bar-down"|"150"|"150"|"arrow-bar-down-open"|"51"|"51"|"arrow-bar-left"|"151"|"151"|"arrow-bar-left-open"|"52"|"52"|"arrow-bar-right"|"152"|"152"|"arrow-bar-right-open"|"53"|"53"|"arrow"|"153"|"153"|"arrow-open"|"54"|"54"|"arrow-wide"|"154"|"154"|"arrow-wide-open")
Default:"circle"Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
- angle
- line
Parent:data[type=violin]
Type: object containing one or more of the keys listed below. - box
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- fillcolor
Parent:data[type=violin].box
Type: colorSets the inner box plot fill color.
- line
Parent:data[type=violin].box
Type: object containing one or more of the keys listed below. - visible
Parent:data[type=violin].box
Type: booleanDetermines if an miniature box plot is drawn inside the violins.
- width
Parent:data[type=violin].box
Type: number between or equal to 0 and 1
Default:0.25Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.
- fillcolor
- quartilemethod
Parent:data[type=violin]
Type: enumerated , one of ("linear"|"exclusive"|"inclusive")
Default:"linear"Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
- selectedpoints
Parent:data[type=violin]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- selected
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=violin].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=violin].selected.marker
Type: colorSets the marker color of selected points.
- opacity
Parent:data[type=violin].selected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of selected points.
- size
Parent:data[type=violin].selected.marker
Type: number greater than or equal to 0Sets the marker size of selected points.
- color
- marker
- unselected
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=violin].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=violin].unselected.marker
Type: colorSets the marker color of unselected points, applied only when a selection exists.
- opacity
Parent:data[type=violin].unselected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of unselected points, applied only when a selection exists.
- size
Parent:data[type=violin].unselected.marker
Type: number greater than or equal to 0Sets the marker size of unselected points, applied only when a selection exists.
- color
- marker
- bandwidth
Parent:data[type=violin]
Type: number greater than or equal to 0Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.
- fillcolor
Parent:data[type=violin]
Type: colorSets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- hoverlabel
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=violin].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=violin].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=violin].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=violin].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=violin].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=violin].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=violin].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=violin].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=violin].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=violin].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=violin].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=violin].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=violin].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=violin].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=violin].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- hoveron
Parent:data[type=violin]
Type: flaglist string. Any combination of"violins","points","kde"joined with a"+"OR"all".
Examples:"violins","points","violins+points","violins+points+kde","all"
Default:"violins+points+kde"Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?
- pointpos
Parent:data[type=violin]
Type: number between or equal to -2 and 2Sets the position of the sample points in relation to the violins. If "0", the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.
- jitter
Parent:data[type=violin]
Type: number between or equal to 0 and 1Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the violins.
- meanline
Parent:data[type=violin]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=violin].meanline
Type: colorSets the mean line color.
- visible
Parent:data[type=violin].meanline
Type: booleanDetermines if a line corresponding to the sample's mean is shown inside the violins. If `box.visible` is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.
- width
Parent:data[type=violin].meanline
Type: number greater than or equal to 0Sets the mean line width.
- color
- points
Parent:data[type=violin]
Type: enumerated , one of ("all"|"outliers"|"suspectedoutliers"|false)If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If "false", only the violins are shown with no sample points. Defaults to "suspectedoutliers" when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to "outliers".
- scalegroup
Parent:data[type=violin]
Type: string
Default:""If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together
- scalemode
Parent:data[type=violin]
Type: enumerated , one of ("width"|"count")
Default:"width"Sets the metric by which the width of each violin is determined. "width" means each violin has the same (max) width "count" means the violins are scaled by the number of sample points making up each violin.
- side
Parent:data[type=violin]
Type: enumerated , one of ("both"|"positive"|"negative")
Default:"both"Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has `side` set to "positive" and the other to "negative".
- span
Parent:data[type=violin]
Type: arraySets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual".
- spanmode
Parent:data[type=violin]
Type: enumerated , one of ("soft"|"hard"|"manual")
Default:"soft"Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute.
- uirevision
Parent:data[type=violin]
Type: number or categorical coordinate stringControls 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.
histogram traces
histogram trace is an object with the key "type" equal to "histogram" (i.e. {"type": "histogram"}) and any of the keys listed below. The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided.
- type
Parent:data[type=histogram]
Type: "histogram" - name
Parent:data[type=histogram]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=histogram]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=histogram]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=histogram]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=histogram]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=histogram]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=histogram].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=histogram].legendgrouptitle.font
Type: color - family
Parent:data[type=histogram].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=histogram].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=histogram].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=histogram].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=histogram]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=histogram]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=histogram]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=histogram]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=histogram]
Type: data arraySets the sample data to be binned on the x axis.
- y
Parent:data[type=histogram]
Type: data arraySets the sample data to be binned on the y axis.
- text
Parent:data[type=histogram]
Type: string or array of strings
Default:""Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.
- textposition
Parent:data[type=histogram]
Type: enumerated , one of ("inside"|"outside"|"auto"|"none")
Default:"auto"Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If "none", no text appears.
- texttemplate
Parent:data[type=histogram]
Type: string
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label` and `value`.
- texttemplatefallback
Parent:data[type=histogram]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=histogram]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=histogram]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=histogram]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `binNumber` Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=histogram]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=histogram]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=histogram]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=histogram]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=histogram]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=histogram]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=histogram]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=histogram]
Type: enumerated , one of ("v"|"h")Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
- histfunc
Parent:data[type=histogram]
Type: enumerated , one of ("count"|"sum"|"avg"|"min"|"max")
Default:"count"Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
- histnorm
Parent:data[type=histogram]
Type: enumerated , one of (""|"percent"|"probability"|"density"|"probability density")
Default:""Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
- alignmentgroup
Parent:data[type=histogram]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=histogram]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- nbinsx
Parent:data[type=histogram]
Type: integer greater than or equal to 0
Default:0Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.
- nbinsy
Parent:data[type=histogram]
Type: integer greater than or equal to 0
Default:0Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.
- autobinx
Parent:data[type=histogram]
Type: booleanObsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.
- autobiny
Parent:data[type=histogram]
Type: booleanObsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.
- bingroup
Parent:data[type=histogram]
Type: string
Default:""Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same "orientation" under `barmode` "stack", "relative" and "group" are forced into the same bingroup, Using `bingroup`, traces under `barmode` "overlay" and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d" trace can share the same `bingroup`
- xbins
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- end
Parent:data[type=histogram].xbins
Type: number or categorical coordinate stringSets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
- size
Parent:data[type=histogram].xbins
Type: number or categorical coordinate stringSets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.
- start
Parent:data[type=histogram].xbins
Type: number or categorical coordinate stringSets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
- end
- ybins
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- end
Parent:data[type=histogram].ybins
Type: number or categorical coordinate stringSets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
- size
Parent:data[type=histogram].ybins
Type: number or categorical coordinate stringSets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.
- start
Parent:data[type=histogram].ybins
Type: number or categorical coordinate stringSets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
- end
- marker
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=histogram].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=histogram].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=histogram].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=histogram].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=histogram].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=histogram].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=histogram].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=histogram].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=histogram].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=histogram].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=histogram].marker.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=histogram].marker.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=histogram].marker.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=histogram].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=histogram].marker.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=histogram].marker.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=histogram].marker.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=histogram].marker.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=histogram].marker.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=histogram].marker.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=histogram].marker.colorbar.tickfont
Type: color - family
Parent:data[type=histogram].marker.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram].marker.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].marker.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=histogram].marker.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].marker.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=histogram].marker.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=histogram].marker.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=histogram].marker.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=histogram].marker.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=histogram].marker.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=histogram].marker.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=histogram].marker.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=histogram].marker.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=histogram].marker.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=histogram].marker.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=histogram].marker.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=histogram].marker.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=histogram].marker.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=histogram].marker.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=histogram].marker.colorbar.title.font
Type: color - family
Parent:data[type=histogram].marker.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram].marker.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].marker.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=histogram].marker.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=histogram].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].marker.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=histogram].marker.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=histogram].marker.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=histogram].marker.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=histogram].marker.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=histogram].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=histogram].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=histogram].marker
Type: colorscaleSets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- cornerradius
Parent:data[type=histogram].marker
Type: number or categorical coordinate stringSets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to `layout.barcornerradius`. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.
- line
Parent:data[type=histogram].marker
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=histogram].marker.line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=histogram].marker.line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
- cmax
Parent:data[type=histogram].marker.line
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
- cmid
Parent:data[type=histogram].marker.line
Type: numberSets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.
- cmin
Parent:data[type=histogram].marker.line
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
- color
Parent:data[type=histogram].marker.line
Type: color or array of colorsSets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- coloraxis
Parent:data[type=histogram].marker.line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorscale
Parent:data[type=histogram].marker.line
Type: colorscaleSets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- reversescale
Parent:data[type=histogram].marker.line
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
- width
Parent:data[type=histogram].marker.line
Type: number or array of numbers greater than or equal to 0
Default:0Sets the width (in px) of the lines bounding the marker points.
- autocolorscale
- opacity
Parent:data[type=histogram].marker
Type: number or array of numbers between or equal to 0 and 1
Default:1Sets the opacity of the bars.
- pattern
Parent:data[type=histogram].marker
Type: object containing one or more of the keys listed below.Sets the pattern within the marker.
- bgcolor
Parent:data[type=histogram].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is "overlay". Otherwise, defaults to a transparent background.
- fgcolor
Parent:data[type=histogram].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is "replace". Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.
- fgopacity
Parent:data[type=histogram].marker.pattern
Type: number between or equal to 0 and 1Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
- fillmode
Parent:data[type=histogram].marker.pattern
Type: enumerated , one of ("replace"|"overlay")
Default:"replace"Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.
- path
Parent:data[type=histogram].marker.pattern
Type: string or array of stringsSets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.
- shape
Parent:data[type=histogram].marker.pattern
Type: enumerated or array of enumerateds , one of (""|"/"|"\"|"x"|"-"|"|"|"+"|".")
Default:""Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- size
Parent:data[type=histogram].marker.pattern
Type: number or array of numbers greater than or equal to 0
Default:8Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- solidity
Parent:data[type=histogram].marker.pattern
Type: number or array of numbers between or equal to 0 and 1
Default:0.3Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- bgcolor
- reversescale
Parent:data[type=histogram].marker
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
- showscale
Parent:data[type=histogram].marker
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.
- autocolorscale
- textangle
Parent:data[type=histogram]
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
- textfont
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.Sets the text font.
- color
Parent:data[type=histogram].textfont
Type: color - family
Parent:data[type=histogram].textfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].textfont
Type: string
Default:"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.
- size
Parent:data[type=histogram].textfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram].textfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].textfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].textfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].textfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- error_x
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=histogram].error_x
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=histogram].error_x
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=histogram].error_x
Type: colorSets the stroke color of the error bars.
- copy_ystyle
Parent:data[type=histogram].error_x
Type: boolean - symmetric
Parent:data[type=histogram].error_x
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=histogram].error_x
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=histogram].error_x
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=histogram].error_x
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=histogram].error_x
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=histogram].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=histogram].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=histogram].error_x
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=histogram].error_x
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- error_y
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=histogram].error_y
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=histogram].error_y
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=histogram].error_y
Type: colorSets the stroke color of the error bars.
- symmetric
Parent:data[type=histogram].error_y
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=histogram].error_y
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=histogram].error_y
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=histogram].error_y
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=histogram].error_y
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=histogram].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=histogram].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=histogram].error_y
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=histogram].error_y
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- selectedpoints
Parent:data[type=histogram]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- selected
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=histogram].selected
Type: object containing one or more of the keys listed below. - textfont
Parent:data[type=histogram].selected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=histogram].selected.textfont
Type: colorSets the text font color of selected points.
- color
- marker
- unselected
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=histogram].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=histogram].unselected.marker
Type: colorSets the marker color of unselected points, applied only when a selection exists.
- opacity
Parent:data[type=histogram].unselected.marker
Type: number between or equal to 0 and 1Sets the marker opacity of unselected points, applied only when a selection exists.
- color
- textfont
Parent:data[type=histogram].unselected
Type: object containing one or more of the keys listed below.- color
Parent:data[type=histogram].unselected.textfont
Type: colorSets the text font color of unselected points, applied only when a selection exists.
- color
- marker
- cliponaxis
Parent:data[type=histogram]
Type: boolean
Default:trueDetermines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
- constraintext
Parent:data[type=histogram]
Type: enumerated , one of ("inside"|"outside"|"both"|"none")
Default:"both"Constrain the size of text inside or outside a bar to be no larger than the bar itself.
- cumulative
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- currentbin
Parent:data[type=histogram].cumulative
Type: enumerated , one of ("include"|"exclude"|"half")
Default:"include"Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. "include" is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. "exclude" makes the opposite half-bin bias, and "half" removes it.
- direction
Parent:data[type=histogram].cumulative
Type: enumerated , one of ("increasing"|"decreasing")
Default:"increasing"Only applies if cumulative is enabled. If "increasing" (default) we sum all prior bins, so the result increases from left to right. If "decreasing" we sum later bins so the result decreases from left to right.
- enabled
Parent:data[type=histogram].cumulative
Type: booleanIf true, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and "probability density" both rise to the number of sample points.
- currentbin
- hoverlabel
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=histogram].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=histogram].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=histogram].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=histogram].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=histogram].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=histogram].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=histogram].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=histogram].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=histogram].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=histogram].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=histogram].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- insidetextanchor
Parent:data[type=histogram]
Type: enumerated , one of ("end"|"middle"|"start")
Default:"end"Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
- insidetextfont
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying inside the bar.
- color
Parent:data[type=histogram].insidetextfont
Type: color - family
Parent:data[type=histogram].insidetextfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram].insidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].insidetextfont
Type: string
Default:"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.
- size
Parent:data[type=histogram].insidetextfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram].insidetextfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].insidetextfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].insidetextfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].insidetextfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- outsidetextfont
Parent:data[type=histogram]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying outside the bar.
- color
Parent:data[type=histogram].outsidetextfont
Type: color - family
Parent:data[type=histogram].outsidetextfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram].outsidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram].outsidetextfont
Type: string
Default:"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.
- size
Parent:data[type=histogram].outsidetextfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram].outsidetextfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram].outsidetextfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram].outsidetextfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram].outsidetextfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- xcalendar
Parent:data[type=histogram]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=histogram]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=histogram]
Type: number or categorical coordinate stringControls 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.
histogram2d traces
histogram2d trace is an object with the key "type" equal to "histogram2d" (i.e. {"type": "histogram2d"}) and any of the keys listed below. The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.
- type
Parent:data[type=histogram2d]
Type: "histogram2d" - name
Parent:data[type=histogram2d]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=histogram2d]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=histogram2d]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=histogram2d]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=histogram2d]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=histogram2d]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=histogram2d].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=histogram2d].legendgrouptitle.font
Type: color - family
Parent:data[type=histogram2d].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2d].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2d].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=histogram2d].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2d].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=histogram2d].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=histogram2d]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=histogram2d]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=histogram2d]
Type: data arrayAssigns 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.
- x
Parent:data[type=histogram2d]
Type: data arraySets the sample data to be binned on the x axis.
- xgap
Parent:data[type=histogram2d]
Type: number greater than or equal to 0
Default:0Sets the horizontal gap (in pixels) between bricks.
- y
Parent:data[type=histogram2d]
Type: data arraySets the sample data to be binned on the y axis.
- ygap
Parent:data[type=histogram2d]
Type: number greater than or equal to 0
Default:0Sets the vertical gap (in pixels) between bricks.
- z
Parent:data[type=histogram2d]
Type: data arraySets the aggregation data.
- texttemplate
Parent:data[type=histogram2d]
Type: string
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z`
- texttemplatefallback
Parent:data[type=histogram2d]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hoverinfo
Parent:data[type=histogram2d]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=histogram2d]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z` Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=histogram2d]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=histogram2d]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=histogram2d]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=histogram2d]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=histogram2d]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=histogram2d]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=histogram2d]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- coloraxis
Parent:data[type=histogram2d]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- histfunc
Parent:data[type=histogram2d]
Type: enumerated , one of ("count"|"sum"|"avg"|"min"|"max")
Default:"count"Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
- histnorm
Parent:data[type=histogram2d]
Type: enumerated , one of (""|"percent"|"probability"|"density"|"probability density")
Default:""Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
- nbinsx
Parent:data[type=histogram2d]
Type: integer greater than or equal to 0
Default:0Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.
- nbinsy
Parent:data[type=histogram2d]
Type: integer greater than or equal to 0
Default:0Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.
- autobinx
Parent:data[type=histogram2d]
Type: booleanObsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.
- autobiny
Parent:data[type=histogram2d]
Type: booleanObsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.
- bingroup
Parent:data[type=histogram2d]
Type: string
Default:""Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of "1" on two histogram2d traces will make them their x-bins and y-bins match separately.
- xbingroup
Parent:data[type=histogram2d]
Type: string
Default:""Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`
- xbins
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.- end
Parent:data[type=histogram2d].xbins
Type: number or categorical coordinate stringSets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
- size
Parent:data[type=histogram2d].xbins
Type: number or categorical coordinate stringSets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
- start
Parent:data[type=histogram2d].xbins
Type: number or categorical coordinate stringSets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
- end
- ybingroup
Parent:data[type=histogram2d]
Type: string
Default:""Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`
- ybins
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.- end
Parent:data[type=histogram2d].ybins
Type: number or categorical coordinate stringSets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
- size
Parent:data[type=histogram2d].ybins
Type: number or categorical coordinate stringSets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
- start
Parent:data[type=histogram2d].ybins
Type: number or categorical coordinate stringSets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
- end
- marker
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=histogram2d].marker
Type: data arraySets the aggregation data.
- color
- textfont
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.Sets the text font.
- color
Parent:data[type=histogram2d].textfont
Type: color
Default:"auto" - family
Parent:data[type=histogram2d].textfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2d].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2d].textfont
Type: string
Default:"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.
- size
Parent:data[type=histogram2d].textfont
Type: number greater than or equal to 1
Default:"auto" - style
Parent:data[type=histogram2d].textfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2d].textfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2d].textfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2d].textfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- colorbar
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=histogram2d].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=histogram2d].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=histogram2d].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=histogram2d].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=histogram2d].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=histogram2d].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=histogram2d].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=histogram2d].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=histogram2d].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=histogram2d].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=histogram2d].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=histogram2d].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=histogram2d].colorbar.tickfont
Type: color - family
Parent:data[type=histogram2d].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2d].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2d].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=histogram2d].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2d].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2d].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2d].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2d].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=histogram2d].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=histogram2d].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=histogram2d].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=histogram2d].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=histogram2d].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=histogram2d].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=histogram2d].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=histogram2d].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=histogram2d].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=histogram2d].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=histogram2d].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=histogram2d].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=histogram2d].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=histogram2d].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=histogram2d].colorbar.title.font
Type: color - family
Parent:data[type=histogram2d].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2d].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2d].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=histogram2d].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2d].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2d].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2d].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2d].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=histogram2d].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=histogram2d].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=histogram2d].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=histogram2d].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=histogram2d].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=histogram2d].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=histogram2d]
Type: booleanDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=histogram2d]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=histogram2d]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=histogram2d]
Type: booleanReverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
- zauto
Parent:data[type=histogram2d]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.
- zhoverformat
Parent:data[type=histogram2d]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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.By default the values are formatted using generic number format.
- zmax
Parent:data[type=histogram2d]
Type: numberSets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
- zmid
Parent:data[type=histogram2d]
Type: numberSets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.
- zmin
Parent:data[type=histogram2d]
Type: numberSets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
- zsmooth
Parent:data[type=histogram2d]
Type: enumerated , one of ("fast"|"best"|false)Picks a smoothing algorithm use to smooth `z` data.
- hoverlabel
Parent:data[type=histogram2d]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=histogram2d].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=histogram2d].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=histogram2d].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=histogram2d].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=histogram2d].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=histogram2d].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=histogram2d].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2d].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=histogram2d].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=histogram2d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2d].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=histogram2d].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=histogram2d].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- xcalendar
Parent:data[type=histogram2d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=histogram2d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=histogram2d]
Type: number or categorical coordinate stringControls 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.
histogram2dcontour traces
histogram2dcontour trace is an object with the key "type" equal to "histogram2dcontour" (i.e. {"type": "histogram2dcontour"}) and any of the keys listed below. The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.
- type
Parent:data[type=histogram2dcontour]
Type: "histogram2dcontour" - name
Parent:data[type=histogram2dcontour]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=histogram2dcontour]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=histogram2dcontour]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=histogram2dcontour]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=histogram2dcontour]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=histogram2dcontour]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=histogram2dcontour].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: color - family
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2dcontour].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=histogram2dcontour].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=histogram2dcontour]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=histogram2dcontour]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=histogram2dcontour]
Type: data arrayAssigns 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.
- x
Parent:data[type=histogram2dcontour]
Type: data arraySets the sample data to be binned on the x axis.
- y
Parent:data[type=histogram2dcontour]
Type: data arraySets the sample data to be binned on the y axis.
- z
Parent:data[type=histogram2dcontour]
Type: data arraySets the aggregation data.
- texttemplate
Parent:data[type=histogram2dcontour]
Type: string
Default:""For this trace it only has an effect if `coloring` is set to "heatmap". Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.
- texttemplatefallback
Parent:data[type=histogram2dcontour]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hoverinfo
Parent:data[type=histogram2dcontour]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=histogram2dcontour]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z` Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=histogram2dcontour]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=histogram2dcontour]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=histogram2dcontour]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=histogram2dcontour]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=histogram2dcontour]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=histogram2dcontour]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=histogram2dcontour]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- coloraxis
Parent:data[type=histogram2dcontour]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- histfunc
Parent:data[type=histogram2dcontour]
Type: enumerated , one of ("count"|"sum"|"avg"|"min"|"max")
Default:"count"Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
- histnorm
Parent:data[type=histogram2dcontour]
Type: enumerated , one of (""|"percent"|"probability"|"density"|"probability density")
Default:""Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
- nbinsx
Parent:data[type=histogram2dcontour]
Type: integer greater than or equal to 0
Default:0Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.
- nbinsy
Parent:data[type=histogram2dcontour]
Type: integer greater than or equal to 0
Default:0Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.
- autobinx
Parent:data[type=histogram2dcontour]
Type: booleanObsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.
- autobiny
Parent:data[type=histogram2dcontour]
Type: booleanObsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.
- bingroup
Parent:data[type=histogram2dcontour]
Type: string
Default:""Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of "1" on two histogram2d traces will make them their x-bins and y-bins match separately.
- xbingroup
Parent:data[type=histogram2dcontour]
Type: string
Default:""Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`
- xbins
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- end
Parent:data[type=histogram2dcontour].xbins
Type: number or categorical coordinate stringSets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
- size
Parent:data[type=histogram2dcontour].xbins
Type: number or categorical coordinate stringSets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
- start
Parent:data[type=histogram2dcontour].xbins
Type: number or categorical coordinate stringSets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
- end
- ybingroup
Parent:data[type=histogram2dcontour]
Type: string
Default:""Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`
- ybins
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- end
Parent:data[type=histogram2dcontour].ybins
Type: number or categorical coordinate stringSets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
- size
Parent:data[type=histogram2dcontour].ybins
Type: number or categorical coordinate stringSets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
- start
Parent:data[type=histogram2dcontour].ybins
Type: number or categorical coordinate stringSets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
- end
- marker
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=histogram2dcontour].marker
Type: data arraySets the aggregation data.
- color
- line
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=histogram2dcontour].line
Type: colorSets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".
- dash
Parent:data[type=histogram2dcontour].line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- smoothing
Parent:data[type=histogram2dcontour].line
Type: number between or equal to 0 and 1.3
Default:1Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.
- width
Parent:data[type=histogram2dcontour].line
Type: number greater than or equal to 0
Default:0.5Sets the contour line width in (in px)
- color
- textfont
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.For this trace it only has an effect if `coloring` is set to "heatmap". Sets the text font.
- color
Parent:data[type=histogram2dcontour].textfont
Type: color
Default:"auto" - family
Parent:data[type=histogram2dcontour].textfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2dcontour].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2dcontour].textfont
Type: string
Default:"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.
- size
Parent:data[type=histogram2dcontour].textfont
Type: number greater than or equal to 1
Default:"auto" - style
Parent:data[type=histogram2dcontour].textfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2dcontour].textfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2dcontour].textfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2dcontour].textfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- colorbar
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=histogram2dcontour].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=histogram2dcontour].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=histogram2dcontour].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=histogram2dcontour].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=histogram2dcontour].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=histogram2dcontour].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=histogram2dcontour].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=histogram2dcontour].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=histogram2dcontour].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=histogram2dcontour].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=histogram2dcontour].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=histogram2dcontour].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: color - family
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2dcontour].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=histogram2dcontour].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=histogram2dcontour].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=histogram2dcontour].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=histogram2dcontour].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=histogram2dcontour].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=histogram2dcontour].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=histogram2dcontour].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=histogram2dcontour].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=histogram2dcontour].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=histogram2dcontour].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=histogram2dcontour].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=histogram2dcontour].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=histogram2dcontour].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=histogram2dcontour].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: color - family
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2dcontour].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=histogram2dcontour].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=histogram2dcontour].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=histogram2dcontour].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=histogram2dcontour].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=histogram2dcontour].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=histogram2dcontour].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=histogram2dcontour]
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=histogram2dcontour]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=histogram2dcontour]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=histogram2dcontour]
Type: booleanReverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
- zauto
Parent:data[type=histogram2dcontour]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.
- zhoverformat
Parent:data[type=histogram2dcontour]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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.By default the values are formatted using generic number format.
- zmax
Parent:data[type=histogram2dcontour]
Type: numberSets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
- zmid
Parent:data[type=histogram2dcontour]
Type: numberSets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.
- zmin
Parent:data[type=histogram2dcontour]
Type: numberSets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
- autocontour
Parent:data[type=histogram2dcontour]
Type: boolean
Default:trueDetermines whether or not the contour level attributes are picked by an algorithm. If "true", the number of contour levels can be set in `ncontours`. If "false", set the contour level attributes in `contours`.
- contours
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- coloring
Parent:data[type=histogram2dcontour].contours
Type: enumerated , one of ("fill"|"heatmap"|"lines"|"none")
Default:"fill"Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.
- end
Parent:data[type=histogram2dcontour].contours
Type: numberSets the end contour level value. Must be more than `contours.start`
- labelfont
Parent:data[type=histogram2dcontour].contours
Type: object containing one or more of the keys listed below.Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.
- color
Parent:data[type=histogram2dcontour].contours.labelfont
Type: color - family
Parent:data[type=histogram2dcontour].contours.labelfont
Type: stringHTML 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.
- lineposition
Parent:data[type=histogram2dcontour].contours.labelfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2dcontour].contours.labelfont
Type: string
Default:"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.
- size
Parent:data[type=histogram2dcontour].contours.labelfont
Type: number greater than or equal to 1 - style
Parent:data[type=histogram2dcontour].contours.labelfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2dcontour].contours.labelfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2dcontour].contours.labelfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2dcontour].contours.labelfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- labelformat
Parent:data[type=histogram2dcontour].contours
Type: string
Default:""Sets the contour 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.
- operation
Parent:data[type=histogram2dcontour].contours
Type: enumerated , one of ("="|"<"|">="|">"|"<="|"[]"|"()"|"[)"|"(]"|"]["|")("|"]("|")[")
Default:"="Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.
- showlabels
Parent:data[type=histogram2dcontour].contours
Type: booleanDetermines whether to label the contour lines with their values.
- showlines
Parent:data[type=histogram2dcontour].contours
Type: boolean
Default:trueDetermines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
- size
Parent:data[type=histogram2dcontour].contours
Type: number greater than or equal to 0Sets the step between each contour level. Must be positive.
- start
Parent:data[type=histogram2dcontour].contours
Type: numberSets the starting contour level value. Must be less than `contours.end`
- type
Parent:data[type=histogram2dcontour].contours
Type: enumerated , one of ("levels"|"constraint")
Default:"levels"If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.
- value
Parent:data[type=histogram2dcontour].contours
Type: number or categorical coordinate string
Default:0Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (`=,<,>=,>,<=`) "value" is expected to be a number. When `operation` is set to one of the interval values (`[],(),[),(],][,)(,](,)[`) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
- coloring
- hoverlabel
Parent:data[type=histogram2dcontour]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=histogram2dcontour].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=histogram2dcontour].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=histogram2dcontour].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=histogram2dcontour].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=histogram2dcontour].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=histogram2dcontour].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=histogram2dcontour].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- ncontours
Parent:data[type=histogram2dcontour]
Type: integer greater than or equal to 1
Default:15Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "true" or if `contours.size` is missing.
- xcalendar
Parent:data[type=histogram2dcontour]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=histogram2dcontour]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- uirevision
Parent:data[type=histogram2dcontour]
Type: number or categorical coordinate stringControls 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.
ohlc traces
ohlc trace is an object with the key "type" equal to "ohlc" (i.e. {"type": "ohlc"}) and any of the keys listed below. The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red.
- type
Parent:data[type=ohlc]
Type: "ohlc" - name
Parent:data[type=ohlc]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=ohlc]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=ohlc]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=ohlc]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=ohlc]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=ohlc]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=ohlc]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=ohlc].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=ohlc].legendgrouptitle.font
Type: color - family
Parent:data[type=ohlc].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=ohlc].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=ohlc].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=ohlc].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=ohlc].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=ohlc].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=ohlc].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=ohlc].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=ohlc].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=ohlc]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=ohlc]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=ohlc]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=ohlc]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=ohlc]
Type: data arraySets the x coordinates. If absent, linear coordinate will be generated.
- close
Parent:data[type=ohlc]
Type: data arraySets the close values.
- open
Parent:data[type=ohlc]
Type: data arraySets the open values.
- high
Parent:data[type=ohlc]
Type: data arraySets the high values.
- low
Parent:data[type=ohlc]
Type: data arraySets the low values.
- text
Parent:data[type=ohlc]
Type: string or array of strings
Default:""Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.
- hovertext
Parent:data[type=ohlc]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=ohlc]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=ohlc]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `open`, `high`, `low` and `close`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=ohlc]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=ohlc]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=ohlc]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=ohlc]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=ohlc]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=ohlc]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=ohlc]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- xperiod
Parent:data[type=ohlc]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=ohlc]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=ohlc]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- line
Parent:data[type=ohlc]
Type: object containing one or more of the keys listed below.- dash
Parent:data[type=ohlc].line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.
- width
Parent:data[type=ohlc].line
Type: number greater than or equal to 0
Default:2[object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.
- dash
- selectedpoints
Parent:data[type=ohlc]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- increasing
Parent:data[type=ohlc]
Type: object containing one or more of the keys listed below.- line
Parent:data[type=ohlc].increasing
Type: object containing one or more of the keys listed below.- color
Parent:data[type=ohlc].increasing.line
Type: color
Default:"#3D9970"Sets the line color.
- dash
Parent:data[type=ohlc].increasing.line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- width
Parent:data[type=ohlc].increasing.line
Type: number greater than or equal to 0
Default:2Sets the line width (in px).
- color
- line
- decreasing
Parent:data[type=ohlc]
Type: object containing one or more of the keys listed below.- line
Parent:data[type=ohlc].decreasing
Type: object containing one or more of the keys listed below.- color
Parent:data[type=ohlc].decreasing.line
Type: color
Default:"#FF4136"Sets the line color.
- dash
Parent:data[type=ohlc].decreasing.line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- width
Parent:data[type=ohlc].decreasing.line
Type: number greater than or equal to 0
Default:2Sets the line width (in px).
- color
- line
- hoverlabel
Parent:data[type=ohlc]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=ohlc].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=ohlc].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=ohlc].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=ohlc].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=ohlc].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=ohlc].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=ohlc].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=ohlc].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=ohlc].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=ohlc].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=ohlc].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=ohlc].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=ohlc].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=ohlc].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=ohlc].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- split
Parent:data[type=ohlc].hoverlabel
Type: booleanShow hover information (open, close, high, low) in separate labels, rather than a single unified label. Default: "false". When set to "true", `hovertemplate` is ignored.
- align
- tickwidth
Parent:data[type=ohlc]
Type: number between or equal to 0 and 0.5
Default:0.3Sets the width of the open/close tick marks relative to the "x" minimal interval.
- xcalendar
Parent:data[type=ohlc]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- uirevision
Parent:data[type=ohlc]
Type: number or categorical coordinate stringControls 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.
candlestick traces
candlestick trace is an object with the key "type" equal to "candlestick" (i.e. {"type": "candlestick"}) and any of the keys listed below. The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red.
- type
Parent:data[type=candlestick]
Type: "candlestick" - name
Parent:data[type=candlestick]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=candlestick]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=candlestick]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=candlestick]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=candlestick]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=candlestick]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=candlestick]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=candlestick].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=candlestick].legendgrouptitle.font
Type: color - family
Parent:data[type=candlestick].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=candlestick].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=candlestick].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=candlestick].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=candlestick].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=candlestick].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=candlestick].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=candlestick].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=candlestick].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=candlestick]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=candlestick]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=candlestick]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=candlestick]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=candlestick]
Type: data arraySets the x coordinates. If absent, linear coordinate will be generated.
- close
Parent:data[type=candlestick]
Type: data arraySets the close values.
- open
Parent:data[type=candlestick]
Type: data arraySets the open values.
- high
Parent:data[type=candlestick]
Type: data arraySets the high values.
- low
Parent:data[type=candlestick]
Type: data arraySets the low values.
- text
Parent:data[type=candlestick]
Type: string or array of strings
Default:""Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.
- hovertext
Parent:data[type=candlestick]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=candlestick]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=candlestick]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `open`, `high`, `low` and `close`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=candlestick]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=candlestick]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=candlestick]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=candlestick]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=candlestick]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=candlestick]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=candlestick]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- xperiod
Parent:data[type=candlestick]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=candlestick]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=candlestick]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- line
Parent:data[type=candlestick]
Type: object containing one or more of the keys listed below.- width
Parent:data[type=candlestick].line
Type: number greater than or equal to 0
Default:2Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.
- width
- whiskerwidth
Parent:data[type=candlestick]
Type: number between or equal to 0 and 1
Default:0Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).
- selectedpoints
Parent:data[type=candlestick]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- increasing
Parent:data[type=candlestick]
Type: object containing one or more of the keys listed below.- fillcolor
Parent:data[type=candlestick].increasing
Type: colorSets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- line
Parent:data[type=candlestick].increasing
Type: object containing one or more of the keys listed below.
- fillcolor
- decreasing
Parent:data[type=candlestick]
Type: object containing one or more of the keys listed below.- fillcolor
Parent:data[type=candlestick].decreasing
Type: colorSets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
- line
Parent:data[type=candlestick].decreasing
Type: object containing one or more of the keys listed below.
- fillcolor
- hoverlabel
Parent:data[type=candlestick]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=candlestick].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=candlestick].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=candlestick].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=candlestick].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=candlestick].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=candlestick].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=candlestick].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=candlestick].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=candlestick].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=candlestick].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=candlestick].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=candlestick].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=candlestick].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=candlestick].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=candlestick].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- split
Parent:data[type=candlestick].hoverlabel
Type: booleanShow hover information (open, close, high, low) in separate labels, rather than a single unified label. Default: "false". When set to "true", `hovertemplate` is ignored.
- align
- xcalendar
Parent:data[type=candlestick]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- uirevision
Parent:data[type=candlestick]
Type: number or categorical coordinate stringControls 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.
waterfall traces
waterfall trace is an object with the key "type" equal to "waterfall" (i.e. {"type": "waterfall"}) and any of the keys listed below. Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in `y` if `orientation` is set to "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.
- type
Parent:data[type=waterfall]
Type: "waterfall" - name
Parent:data[type=waterfall]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=waterfall]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=waterfall]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=waterfall]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=waterfall]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=waterfall]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=waterfall].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=waterfall].legendgrouptitle.font
Type: color - family
Parent:data[type=waterfall].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=waterfall].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=waterfall].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=waterfall].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=waterfall].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=waterfall].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=waterfall].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=waterfall].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=waterfall].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=waterfall]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=waterfall]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=waterfall]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=waterfall]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=waterfall]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=waterfall]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=waterfall]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- y
Parent:data[type=waterfall]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=waterfall]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=waterfall]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- base
Parent:data[type=waterfall]
Type: numberSets where the bar base is drawn (in position axis units).
- width
Parent:data[type=waterfall]
Type: number or array of numbers greater than or equal to 0Sets the bar width (in position axis units).
- measure
Parent:data[type=waterfall]
Type: data array
Default:An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.
- offset
Parent:data[type=waterfall]
Type: number or array of numbersShifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.
- text
Parent:data[type=waterfall]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=waterfall]
Type: enumerated or array of enumerateds , one of ("inside"|"outside"|"auto"|"none")
Default:"auto"Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If "none", no text appears.
- texttemplate
Parent:data[type=waterfall]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `initial`, `delta`, `final` and `label`.
- texttemplatefallback
Parent:data[type=waterfall]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=waterfall]
Type: string or array of strings
Default:""Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=waterfall]
Type: flaglist string. Any combination of"name","x","y","text","initial","delta","final"joined with a"+"OR"all"or"none"or"skip".
Examples:"name","x","name+x","name+x+y","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=waterfall]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `initial`, `delta` and `final`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=waterfall]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=waterfall]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=waterfall]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=waterfall]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=waterfall]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=waterfall]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=waterfall]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=waterfall]
Type: enumerated , one of ("v"|"h")Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
- alignmentgroup
Parent:data[type=waterfall]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=waterfall]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- xperiod
Parent:data[type=waterfall]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=waterfall]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=waterfall]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=waterfall]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=waterfall]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=waterfall]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- textangle
Parent:data[type=waterfall]
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
- textfont
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.Sets the font used for `text`.
- color
Parent:data[type=waterfall].textfont
Type: color or array of colors - family
Parent:data[type=waterfall].textfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=waterfall].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=waterfall].textfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=waterfall].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=waterfall].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=waterfall].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=waterfall].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=waterfall].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- textinfo
Parent:data[type=waterfall]
Type: flaglist string. Any combination of"label","text","initial","delta","final"joined with a"+"OR"none".
Examples:"label","text","label+text","label+text+initial","none"Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).
- selectedpoints
Parent:data[type=waterfall]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- cliponaxis
Parent:data[type=waterfall]
Type: boolean
Default:trueDetermines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
- connector
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.- line
Parent:data[type=waterfall].connector
Type: object containing one or more of the keys listed below.- color
Parent:data[type=waterfall].connector.line
Type: color
Default:"#444"Sets the line color.
- dash
Parent:data[type=waterfall].connector.line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- width
Parent:data[type=waterfall].connector.line
Type: number greater than or equal to 0
Default:2Sets the line width (in px).
- color
- mode
Parent:data[type=waterfall].connector
Type: enumerated , one of ("spanning"|"between")
Default:"between"Sets the shape of connector lines.
- visible
Parent:data[type=waterfall].connector
Type: boolean
Default:trueDetermines if connector lines are drawn.
- line
- constraintext
Parent:data[type=waterfall]
Type: enumerated , one of ("inside"|"outside"|"both"|"none")
Default:"both"Constrain the size of text inside or outside a bar to be no larger than the bar itself.
- increasing
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=waterfall].increasing
Type: object containing one or more of the keys listed below.
- marker
- decreasing
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=waterfall].decreasing
Type: object containing one or more of the keys listed below.
- marker
- hoverlabel
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=waterfall].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=waterfall].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=waterfall].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=waterfall].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=waterfall].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=waterfall].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=waterfall].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=waterfall].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=waterfall].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=waterfall].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=waterfall].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=waterfall].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=waterfall].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=waterfall].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=waterfall].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- insidetextanchor
Parent:data[type=waterfall]
Type: enumerated , one of ("end"|"middle"|"start")
Default:"end"Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
- insidetextfont
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying inside the bar.
- color
Parent:data[type=waterfall].insidetextfont
Type: color or array of colors - family
Parent:data[type=waterfall].insidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=waterfall].insidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=waterfall].insidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=waterfall].insidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=waterfall].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=waterfall].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=waterfall].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=waterfall].insidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- outsidetextfont
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying outside the bar.
- color
Parent:data[type=waterfall].outsidetextfont
Type: color or array of colors - family
Parent:data[type=waterfall].outsidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=waterfall].outsidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=waterfall].outsidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=waterfall].outsidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=waterfall].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=waterfall].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=waterfall].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=waterfall].outsidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- totals
Parent:data[type=waterfall]
Type: object containing one or more of the keys listed below.- marker
Parent:data[type=waterfall].totals
Type: object containing one or more of the keys listed below.
- marker
- uirevision
Parent:data[type=waterfall]
Type: number or categorical coordinate stringControls 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.
funnel traces
funnel trace is an object with the key "type" equal to "funnel" (i.e. {"type": "funnel"}) and any of the keys listed below. Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a "drop-off" representation wherein each item appears in each stage it traversed. See also the "funnelarea" trace type for a different approach to visualizing funnel data.
- type
Parent:data[type=funnel]
Type: "funnel" - name
Parent:data[type=funnel]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=funnel]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=funnel]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=funnel]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=funnel]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=funnel]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=funnel].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=funnel].legendgrouptitle.font
Type: color - family
Parent:data[type=funnel].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=funnel].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=funnel].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=funnel].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=funnel].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=funnel]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=funnel]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=funnel]
Type: data arrayAssigns 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.
- zorder
Parent:data[type=funnel]
Type: integer
Default:0Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.
- x
Parent:data[type=funnel]
Type: data arraySets the x coordinates.
- x0
Parent:data[type=funnel]
Type: number or categorical coordinate string
Default:0Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
- dx
Parent:data[type=funnel]
Type: number
Default:1Sets the x coordinate step. See `x0` for more info.
- y
Parent:data[type=funnel]
Type: data arraySets the y coordinates.
- y0
Parent:data[type=funnel]
Type: number or categorical coordinate string
Default:0Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
- dy
Parent:data[type=funnel]
Type: number
Default:1Sets the y coordinate step. See `y0` for more info.
- width
Parent:data[type=funnel]
Type: number greater than or equal to 0Sets the bar width (in position axis units).
- offset
Parent:data[type=funnel]
Type: numberShifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.
- text
Parent:data[type=funnel]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=funnel]
Type: enumerated or array of enumerateds , one of ("inside"|"outside"|"auto"|"none")
Default:"auto"Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If "none", no text appears.
- texttemplate
Parent:data[type=funnel]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`.
- texttemplatefallback
Parent:data[type=funnel]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=funnel]
Type: string or array of strings
Default:""Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=funnel]
Type: flaglist string. Any combination of"name","x","y","text","percent initial","percent previous","percent total"joined with a"+"OR"all"or"none"or"skip".
Examples:"name","x","name+x","name+x+y","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=funnel]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=funnel]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=funnel]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=funnel]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=funnel]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=funnel]
Type: data arrayAssigns 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
- xaxis
Parent:data[type=funnel]
Type: subplotid
Default:xSets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
- yaxis
Parent:data[type=funnel]
Type: subplotid
Default:ySets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
- orientation
Parent:data[type=funnel]
Type: enumerated , one of ("v"|"h")Sets the orientation of the funnels. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only "y" array is presented or orientation is set to "v". Also regarding graphs including only 'horizontal' funnels, "autorange" on the "y-axis" are set to "reversed".
- alignmentgroup
Parent:data[type=funnel]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
- offsetgroup
Parent:data[type=funnel]
Type: string
Default:""Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
- xperiod
Parent:data[type=funnel]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the x axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- xperiodalignment
Parent:data[type=funnel]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the x axis.
- xperiod0
Parent:data[type=funnel]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- yperiod
Parent:data[type=funnel]
Type: number or categorical coordinate string
Default:0Only relevant when the axis `type` is "date". Sets the period positioning in milliseconds or "M<n>" on the y axis. Special values in the form of "M<n>" could be used to declare the number of months. In this case `n` must be a positive integer.
- yperiodalignment
Parent:data[type=funnel]
Type: enumerated , one of ("start"|"middle"|"end")
Default:"middle"Only relevant when the axis `type` is "date". Sets the alignment of data points on the y axis.
- yperiod0
Parent:data[type=funnel]
Type: number or categorical coordinate stringOnly relevant when the axis `type` is "date". Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.
- marker
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=funnel].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=funnel].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=funnel].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=funnel].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=funnel].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=funnel].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=funnel].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=funnel].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=funnel].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=funnel].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=funnel].marker.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=funnel].marker.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=funnel].marker.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=funnel].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=funnel].marker.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=funnel].marker.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=funnel].marker.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=funnel].marker.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=funnel].marker.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=funnel].marker.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=funnel].marker.colorbar.tickfont
Type: color - family
Parent:data[type=funnel].marker.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=funnel].marker.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].marker.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=funnel].marker.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=funnel].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].marker.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=funnel].marker.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=funnel].marker.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=funnel].marker.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=funnel].marker.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=funnel].marker.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=funnel].marker.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=funnel].marker.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=funnel].marker.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=funnel].marker.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=funnel].marker.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=funnel].marker.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=funnel].marker.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=funnel].marker.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=funnel].marker.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=funnel].marker.colorbar.title.font
Type: color - family
Parent:data[type=funnel].marker.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=funnel].marker.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].marker.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=funnel].marker.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=funnel].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].marker.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=funnel].marker.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=funnel].marker.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=funnel].marker.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=funnel].marker.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=funnel].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=funnel].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=funnel].marker
Type: colorscaleSets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- line
Parent:data[type=funnel].marker
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=funnel].marker.line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=funnel].marker.line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
- cmax
Parent:data[type=funnel].marker.line
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
- cmid
Parent:data[type=funnel].marker.line
Type: numberSets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.
- cmin
Parent:data[type=funnel].marker.line
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
- color
Parent:data[type=funnel].marker.line
Type: color or array of colorsSets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- coloraxis
Parent:data[type=funnel].marker.line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorscale
Parent:data[type=funnel].marker.line
Type: colorscaleSets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- reversescale
Parent:data[type=funnel].marker.line
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
- width
Parent:data[type=funnel].marker.line
Type: number or array of numbers greater than or equal to 0
Default:0Sets the width (in px) of the lines bounding the marker points.
- autocolorscale
- opacity
Parent:data[type=funnel].marker
Type: number or array of numbers between or equal to 0 and 1
Default:1Sets the opacity of the bars.
- reversescale
Parent:data[type=funnel].marker
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
- showscale
Parent:data[type=funnel].marker
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.
- autocolorscale
- textangle
Parent:data[type=funnel]
Type: angle
Default:0Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
- textfont
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.Sets the font used for `text`.
- color
Parent:data[type=funnel].textfont
Type: color or array of colors - family
Parent:data[type=funnel].textfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnel].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].textfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnel].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnel].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- textinfo
Parent:data[type=funnel]
Type: flaglist string. Any combination of"label","text","percent initial","percent previous","percent total","value"joined with a"+"OR"none".
Examples:"label","text","label+text","label+text+percent initial","none"Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).
- selectedpoints
Parent:data[type=funnel]
Type: number or categorical coordinate stringArray containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
- cliponaxis
Parent:data[type=funnel]
Type: boolean
Default:trueDetermines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
- connector
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.- fillcolor
Parent:data[type=funnel].connector
Type: colorSets the fill color.
- line
Parent:data[type=funnel].connector
Type: object containing one or more of the keys listed below.- color
Parent:data[type=funnel].connector.line
Type: color
Default:"#444"Sets the line color.
- dash
Parent:data[type=funnel].connector.line
Type: string
Default:"solid"Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- width
Parent:data[type=funnel].connector.line
Type: number greater than or equal to 0
Default:0Sets the line width (in px).
- color
- visible
Parent:data[type=funnel].connector
Type: boolean
Default:trueDetermines if connector regions and lines are drawn.
- fillcolor
- constraintext
Parent:data[type=funnel]
Type: enumerated , one of ("inside"|"outside"|"both"|"none")
Default:"both"Constrain the size of text inside or outside a bar to be no larger than the bar itself.
- hoverlabel
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=funnel].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=funnel].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=funnel].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=funnel].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=funnel].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=funnel].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnel].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnel].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnel].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=funnel].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=funnel].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- insidetextanchor
Parent:data[type=funnel]
Type: enumerated , one of ("end"|"middle"|"start")
Default:"middle"Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
- insidetextfont
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying inside the bar.
- color
Parent:data[type=funnel].insidetextfont
Type: color or array of colors - family
Parent:data[type=funnel].insidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnel].insidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].insidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnel].insidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnel].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].insidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- outsidetextfont
Parent:data[type=funnel]
Type: object containing one or more of the keys listed below.Sets the font used for `text` lying outside the bar.
- color
Parent:data[type=funnel].outsidetextfont
Type: color or array of colors - family
Parent:data[type=funnel].outsidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnel].outsidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnel].outsidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnel].outsidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnel].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnel].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnel].outsidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnel].outsidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- uirevision
Parent:data[type=funnel]
Type: number or categorical coordinate stringControls 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.
funnelarea traces
funnelarea trace is an object with the key "type" equal to "funnelarea" (i.e. {"type": "funnelarea"}) and any of the keys listed below. Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a "pie" trace, wherein each item appears in a single stage. See also the "funnel" trace type for a different approach to visualizing funnel data.
- type
Parent:data[type=funnelarea]
Type: "funnelarea" - name
Parent:data[type=funnelarea]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- title
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=funnelarea].title
Type: object containing one or more of the keys listed below.Sets the font used for `title`.
- color
Parent:data[type=funnelarea].title.font
Type: color or array of colors - family
Parent:data[type=funnelarea].title.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnelarea].title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnelarea].title.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnelarea].title.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnelarea].title.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnelarea].title.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnelarea].title.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnelarea].title.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- position
Parent:data[type=funnelarea].title
Type: enumerated , one of ("top left"|"top center"|"top right")
Default:"top center"Specifies the location of the `title`.
- text
Parent:data[type=funnelarea].title
Type: string
Default:""Sets the title of the chart. If it is empty, no title is displayed.
- font
- visible
Parent:data[type=funnelarea]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=funnelarea]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=funnelarea]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=funnelarea]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=funnelarea]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=funnelarea].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=funnelarea].legendgrouptitle.font
Type: color - family
Parent:data[type=funnelarea].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=funnelarea].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnelarea].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=funnelarea].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=funnelarea].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnelarea].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnelarea].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnelarea].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=funnelarea].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=funnelarea]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=funnelarea]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- ids
Parent:data[type=funnelarea]
Type: data arrayAssigns 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.
- values
Parent:data[type=funnelarea]
Type: data arraySets the values of the sectors. If omitted, we count occurrences of each label.
- labels
Parent:data[type=funnelarea]
Type: data arraySets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.
- dlabel
Parent:data[type=funnelarea]
Type: number
Default:1Sets the label step. See `label0` for more info.
- label0
Parent:data[type=funnelarea]
Type: number
Default:0Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
- text
Parent:data[type=funnelarea]
Type: data arraySets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=funnelarea]
Type: enumerated or array of enumerateds , one of ("inside"|"none")
Default:"inside"Specifies the location of the `textinfo`.
- texttemplate
Parent:data[type=funnelarea]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `text` and `percent`.
- texttemplatefallback
Parent:data[type=funnelarea]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=funnelarea]
Type: string or array of strings
Default:""Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=funnelarea]
Type: flaglist string. Any combination of"label","text","value","percent","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"label","text","label+text","label+text+value","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=funnelarea]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `text` and `percent`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=funnelarea]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- meta
Parent:data[type=funnelarea]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=funnelarea]
Type: data arrayAssigns 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
- domain
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.- column
Parent:data[type=funnelarea].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .
- row
Parent:data[type=funnelarea].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .
- x
Parent:data[type=funnelarea].domain
Type: array
Default:[0, 1]Sets the horizontal domain of this funnelarea trace (in plot fraction).
- y
Parent:data[type=funnelarea].domain
Type: array
Default:[0, 1]Sets the vertical domain of this funnelarea trace (in plot fraction).
- column
- marker
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.- colors
Parent:data[type=funnelarea].marker
Type: data arraySets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
- line
Parent:data[type=funnelarea].marker
Type: object containing one or more of the keys listed below.- color
Parent:data[type=funnelarea].marker.line
Type: color or array of colorsSets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.
- width
Parent:data[type=funnelarea].marker.line
Type: number or array of numbers greater than or equal to 0
Default:1Sets the width (in px) of the line enclosing each sector.
- color
- pattern
Parent:data[type=funnelarea].marker
Type: object containing one or more of the keys listed below.Sets the pattern within the marker.
- bgcolor
Parent:data[type=funnelarea].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is "overlay". Otherwise, defaults to a transparent background.
- fgcolor
Parent:data[type=funnelarea].marker.pattern
Type: color or array of colorsWhen there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is "replace". Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.
- fgopacity
Parent:data[type=funnelarea].marker.pattern
Type: number between or equal to 0 and 1Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
- fillmode
Parent:data[type=funnelarea].marker.pattern
Type: enumerated , one of ("replace"|"overlay")
Default:"replace"Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.
- path
Parent:data[type=funnelarea].marker.pattern
Type: string or array of stringsSets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.
- shape
Parent:data[type=funnelarea].marker.pattern
Type: enumerated or array of enumerateds , one of (""|"/"|"\"|"x"|"-"|"|"|"+"|".")
Default:""Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- size
Parent:data[type=funnelarea].marker.pattern
Type: number or array of numbers greater than or equal to 0
Default:8Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- solidity
Parent:data[type=funnelarea].marker.pattern
Type: number or array of numbers between or equal to 0 and 1
Default:0.3Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- bgcolor
- colors
- textfont
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.Sets the font used for `textinfo`.
- color
Parent:data[type=funnelarea].textfont
Type: color or array of colors - family
Parent:data[type=funnelarea].textfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnelarea].textfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnelarea].textfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnelarea].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnelarea].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnelarea].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnelarea].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnelarea].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- textinfo
Parent:data[type=funnelarea]
Type: flaglist string. Any combination of"label","text","value","percent"joined with a"+"OR"none".
Examples:"label","text","label+text","label+text+value","none"Determines which trace information appear on the graph.
- aspectratio
Parent:data[type=funnelarea]
Type: number greater than or equal to 0
Default:1Sets the ratio between height and width
- baseratio
Parent:data[type=funnelarea]
Type: number between or equal to 0 and 1
Default:0.333Sets the ratio between bottom length and maximum top length.
- hoverlabel
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=funnelarea].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=funnelarea].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=funnelarea].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=funnelarea].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=funnelarea].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=funnelarea].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnelarea].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnelarea].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnelarea].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnelarea].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnelarea].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnelarea].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnelarea].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=funnelarea].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=funnelarea].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- insidetextfont
Parent:data[type=funnelarea]
Type: object containing one or more of the keys listed below.Sets the font used for `textinfo` lying inside the sector.
- color
Parent:data[type=funnelarea].insidetextfont
Type: color or array of colors - family
Parent:data[type=funnelarea].insidetextfont
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=funnelarea].insidetextfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=funnelarea].insidetextfont
Type: string or array of strings
Default:"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.
- size
Parent:data[type=funnelarea].insidetextfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=funnelarea].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=funnelarea].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=funnelarea].insidetextfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=funnelarea].insidetextfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- scalegroup
Parent:data[type=funnelarea]
Type: string
Default:""If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
- uirevision
Parent:data[type=funnelarea]
Type: number or categorical coordinate stringControls 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.
indicator traces
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.
- type
Parent:data[type=indicator]
Type: "indicator" - name
Parent:data[type=indicator]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- title
Parent:data[type=indicator]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=indicator].title
Type: enumerated , one of ("left"|"center"|"right")Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.
- font
Parent:data[type=indicator].title
Type: object containing one or more of the keys listed below.Set the font used to display the title
- color
Parent:data[type=indicator].title.font
Type: color - family
Parent:data[type=indicator].title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=indicator].title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=indicator].title.font
Type: string
Default:"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.
- size
Parent:data[type=indicator].title.font
Type: number greater than or equal to 1 - style
Parent:data[type=indicator].title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=indicator].title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=indicator].title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=indicator].title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=indicator].title
Type: stringSets the title of this indicator.
- align
- visible
Parent:data[type=indicator]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- legend
Parent:data[type=indicator]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=indicator]
Type: number
Default:1000Sets 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.
- legendgrouptitle
Parent:data[type=indicator]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=indicator].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=indicator].legendgrouptitle.font
Type: color - family
Parent:data[type=indicator].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=indicator].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=indicator].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=indicator].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=indicator].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=indicator].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=indicator].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=indicator].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=indicator].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=indicator]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- mode
Parent:data[type=indicator]
Type: flaglist string. Any combination of"number","delta","gauge"joined with a"+"
Examples:"number","delta","number+delta","number+delta+gauge"
Default:"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.
- ids
Parent:data[type=indicator]
Type: data arrayAssigns 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.
- value
Parent:data[type=indicator]
Type: numberSets the number to be displayed.
- meta
Parent:data[type=indicator]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=indicator]
Type: data arrayAssigns 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
- domain
Parent:data[type=indicator]
Type: object containing one or more of the keys listed below.- column
Parent:data[type=indicator].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this column in the grid for this indicator trace .
- row
Parent:data[type=indicator].domain
Type: integer greater than or equal to 0
Default:0If there is a layout grid, use the domain for this row in the grid for this indicator trace .
- x
Parent:data[type=indicator].domain
Type: array
Default:[0, 1]Sets the horizontal domain of this indicator trace (in plot fraction).
- y
Parent:data[type=indicator].domain
Type: array
Default:[0, 1]Sets the vertical domain of this indicator trace (in plot fraction).
- column
- align
Parent:data[type=indicator]
Type: enumerated , one of ("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
- delta
Parent:data[type=indicator]
Type: object containing one or more of the keys listed below.- decreasing
Parent:data[type=indicator].delta
Type: object containing one or more of the keys listed below. - font
Parent:data[type=indicator].delta
Type: object containing one or more of the keys listed below.Set the font used to display the delta
- color
Parent:data[type=indicator].delta.font
Type: color - family
Parent:data[type=indicator].delta.font
Type: stringHTML 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.
- lineposition
Parent:data[type=indicator].delta.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=indicator].delta.font
Type: string
Default:"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.
- size
Parent:data[type=indicator].delta.font
Type: number greater than or equal to 1 - style
Parent:data[type=indicator].delta.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=indicator].delta.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=indicator].delta.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=indicator].delta.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- increasing
Parent:data[type=indicator].delta
Type: object containing one or more of the keys listed below. - position
Parent:data[type=indicator].delta
Type: enumerated , one of ("top"|"bottom"|"left"|"right")
Default:"bottom"Sets the position of delta with respect to the number.
- prefix
Parent:data[type=indicator].delta
Type: string
Default:""Sets a prefix appearing before the delta.
- reference
Parent:data[type=indicator].delta
Type: numberSets the reference value to compute the delta. By default, it is set to the current value.
- relative
Parent:data[type=indicator].delta
Type: booleanShow relative change
- suffix
Parent:data[type=indicator].delta
Type: string
Default:""Sets a suffix appearing next to the delta.
- valueformat
Parent:data[type=indicator].delta
Type: stringSets 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.
- decreasing
- number
Parent:data[type=indicator]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=indicator].number
Type: object containing one or more of the keys listed below.Set the font used to display main number
- color
Parent:data[type=indicator].number.font
Type: color - family
Parent:data[type=indicator].number.font
Type: stringHTML 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.
- lineposition
Parent:data[type=indicator].number.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=indicator].number.font
Type: string
Default:"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.
- size
Parent:data[type=indicator].number.font
Type: number greater than or equal to 1 - style
Parent:data[type=indicator].number.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=indicator].number.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=indicator].number.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=indicator].number.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- prefix
Parent:data[type=indicator].number
Type: string
Default:""Sets a prefix appearing before the number.
- suffix
Parent:data[type=indicator].number
Type: string
Default:""Sets a suffix appearing next to the number.
- valueformat
Parent:data[type=indicator].number
Type: string
Default:""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.
- font
- gauge
Parent:data[type=indicator]
Type: object containing one or more of the keys listed below.The gauge of the Indicator plot.
- axis
Parent:data[type=indicator].gauge
Type: object containing one or more of the keys listed below.- dtick
Parent:data[type=indicator].gauge.axis
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=indicator].gauge.axis
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=indicator].gauge.axis
Type: number or categorical coordinate stringReplacement 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.
- minexponent
Parent:data[type=indicator].gauge.axis
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=indicator].gauge.axis
Type: integer greater than or equal to 0
Default:0Specifies 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".
- range
Parent:data[type=indicator].gauge.axis
Type: arraySets the range of this axis.
- separatethousands
Parent:data[type=indicator].gauge.axis
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=indicator].gauge.axis
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=indicator].gauge.axis
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=indicator].gauge.axis
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=indicator].gauge.axis
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- tick0
Parent:data[type=indicator].gauge.axis
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=indicator].gauge.axis
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=indicator].gauge.axis
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=indicator].gauge.axis
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=indicator].gauge.axis.tickfont
Type: color - family
Parent:data[type=indicator].gauge.axis.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=indicator].gauge.axis.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=indicator].gauge.axis.tickfont
Type: string
Default:"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.
- size
Parent:data[type=indicator].gauge.axis.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=indicator].gauge.axis.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=indicator].gauge.axis.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=indicator].gauge.axis.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=indicator].gauge.axis.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=indicator].gauge.axis
Type: string
Default:""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"
- tickformatstops
Parent:data[type=indicator].gauge.axis
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=indicator].gauge.axis.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=indicator].gauge.axis.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=indicator].gauge.axis.tickformatstops[]
Type: stringWhen 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
Parent:data[type=indicator].gauge.axis.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=indicator].gauge.axis.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabelstep
Parent:data[type=indicator].gauge.axis
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=indicator].gauge.axis
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=indicator].gauge.axis
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=indicator].gauge.axis
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=indicator].gauge.axis
Type: enumerated , one of ("outside"|"inside"|"")
Default:"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.
- ticksuffix
Parent:data[type=indicator].gauge.axis
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=indicator].gauge.axis
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=indicator].gauge.axis
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=indicator].gauge.axis
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- visible
Parent:data[type=indicator].gauge.axis
Type: boolean
Default:trueA 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
- dtick
- bar
Parent:data[type=indicator].gauge
Type: object containing one or more of the keys listed below.Set the appearance of the gauge's value
- color
Parent:data[type=indicator].gauge.bar
Type: color
Default:"green"Sets the background color of the arc.
- line
Parent:data[type=indicator].gauge.bar
Type: object containing one or more of the keys listed below. - thickness
Parent:data[type=indicator].gauge.bar
Type: number between or equal to 0 and 1
Default:1Sets the thickness of the bar as a fraction of the total thickness of the gauge.
- color
- bgcolor
Parent:data[type=indicator].gauge
Type: colorSets the gauge background color.
- bordercolor
Parent:data[type=indicator].gauge
Type: color
Default:"#444"Sets the color of the border enclosing the gauge.
- borderwidth
Parent:data[type=indicator].gauge
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the border enclosing the gauge.
- shape
Parent:data[type=indicator].gauge
Type: enumerated , one of ("angular"|"bullet")
Default:"angular"Set the shape of the gauge
- steps
Parent:data[type=indicator].gauge
Type: array of object where each object has one or more of the keys listed below.- color
Parent:data[type=indicator].gauge.steps[]
Type: colorSets the background color of the arc.
- line
Parent:data[type=indicator].gauge.steps[]
Type: object containing one or more of the keys listed below. - name
Parent:data[type=indicator].gauge.steps[]
Type: stringWhen 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.
- range
Parent:data[type=indicator].gauge.steps[]
Type: arraySets the range of this axis.
- templateitemname
Parent:data[type=indicator].gauge.steps[]
Type: stringUsed 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`.
- thickness
Parent:data[type=indicator].gauge.steps[]
Type: number between or equal to 0 and 1
Default:1Sets the thickness of the bar as a fraction of the total thickness of the gauge.
- color
- threshold
Parent:data[type=indicator].gauge
Type: object containing one or more of the keys listed below.- line
Parent:data[type=indicator].gauge.threshold
Type: object containing one or more of the keys listed below. - thickness
Parent:data[type=indicator].gauge.threshold
Type: number between or equal to 0 and 1
Default:0.85Sets the thickness of the threshold line as a fraction of the thickness of the gauge.
- value
Parent:data[type=indicator].gauge.threshold
Type: numberSets a treshold value drawn as a line.
- line
- axis
- uirevision
Parent:data[type=indicator]
Type: number or categorical coordinate stringControls 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.
scatter3d traces
scatter3d trace is an object with the key "type" equal to "scatter3d" (i.e. {"type": "scatter3d"}) and any of the keys listed below. The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.
- type
Parent:data[type=scatter3d]
Type: "scatter3d" - name
Parent:data[type=scatter3d]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=scatter3d]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=scatter3d]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=scatter3d]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=scatter3d]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=scatter3d]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scatter3d].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=scatter3d].legendgrouptitle.font
Type: color - family
Parent:data[type=scatter3d].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter3d].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter3d].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=scatter3d].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=scatter3d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter3d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter3d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=scatter3d].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=scatter3d]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=scatter3d]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- mode
Parent:data[type=scatter3d]
Type: flaglist string. Any combination of"lines","markers","text"joined with a"+"OR"none".
Examples:"lines","markers","lines+markers","lines+markers+text","none"
Default:"lines+markers"Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
- ids
Parent:data[type=scatter3d]
Type: data arrayAssigns 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.
- x
Parent:data[type=scatter3d]
Type: data arraySets the x coordinates.
- y
Parent:data[type=scatter3d]
Type: data arraySets the y coordinates.
- z
Parent:data[type=scatter3d]
Type: data arraySets the z coordinates.
- surfacecolor
Parent:data[type=scatter3d]
Type: colorSets the surface fill color.
- text
Parent:data[type=scatter3d]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=scatter3d]
Type: enumerated or array of enumerateds , one of ("top left"|"top center"|"top right"|"middle left"|"middle center"|"middle right"|"bottom left"|"bottom center"|"bottom right")
Default:"top center"Sets the positions of the `text` elements with respects to the (x,y) coordinates.
- texttemplate
Parent:data[type=scatter3d]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.
- texttemplatefallback
Parent:data[type=scatter3d]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=scatter3d]
Type: string or array of strings
Default:""Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=scatter3d]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=scatter3d]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=scatter3d]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=scatter3d]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=scatter3d]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=scatter3d]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=scatter3d]
Type: data arrayAssigns 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
- scene
Parent:data[type=scatter3d]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- marker
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=scatter3d].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scatter3d].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=scatter3d].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=scatter3d].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=scatter3d].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=scatter3d].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=scatter3d].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=scatter3d].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=scatter3d].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=scatter3d].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=scatter3d].marker.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=scatter3d].marker.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=scatter3d].marker.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=scatter3d].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=scatter3d].marker.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=scatter3d].marker.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=scatter3d].marker.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=scatter3d].marker.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=scatter3d].marker.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=scatter3d].marker.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: color - family
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].marker.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=scatter3d].marker.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=scatter3d].marker.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=scatter3d].marker.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=scatter3d].marker.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=scatter3d].marker.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=scatter3d].marker.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=scatter3d].marker.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=scatter3d].marker.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=scatter3d].marker.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=scatter3d].marker.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=scatter3d].marker.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=scatter3d].marker.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=scatter3d].marker.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scatter3d].marker.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: color - family
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].marker.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=scatter3d].marker.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=scatter3d].marker.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=scatter3d].marker.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=scatter3d].marker.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=scatter3d].marker.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=scatter3d].marker.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=scatter3d].marker
Type: colorscaleSets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- line
Parent:data[type=scatter3d].marker
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=scatter3d].marker.line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scatter3d].marker.line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
- cmax
Parent:data[type=scatter3d].marker.line
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
- cmid
Parent:data[type=scatter3d].marker.line
Type: numberSets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.
- cmin
Parent:data[type=scatter3d].marker.line
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
- color
Parent:data[type=scatter3d].marker.line
Type: color or array of colorsSets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
- coloraxis
Parent:data[type=scatter3d].marker.line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorscale
Parent:data[type=scatter3d].marker.line
Type: colorscaleSets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- reversescale
Parent:data[type=scatter3d].marker.line
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
- width
Parent:data[type=scatter3d].marker.line
Type: number greater than or equal to 0Sets the width (in px) of the lines bounding the marker points.
- autocolorscale
- opacity
Parent:data[type=scatter3d].marker
Type: number between or equal to 0 and 1Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set "marker.color" to an rgba color and use its alpha channel.
- reversescale
Parent:data[type=scatter3d].marker
Type: booleanReverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
- showscale
Parent:data[type=scatter3d].marker
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.
- size
Parent:data[type=scatter3d].marker
Type: number or array of numbers greater than or equal to 0
Default:8Sets the marker size (in px).
- sizemin
Parent:data[type=scatter3d].marker
Type: number greater than or equal to 0
Default:0Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
- sizemode
Parent:data[type=scatter3d].marker
Type: enumerated , one of ("diameter"|"area")
Default:"diameter"Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
- sizeref
Parent:data[type=scatter3d].marker
Type: number
Default:1Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
- symbol
Parent:data[type=scatter3d].marker
Type: enumerated or array of enumerateds , one of ("circle"|"circle-open"|"cross"|"diamond"|"diamond-open"|"square"|"square-open"|"x")
Default:"circle"Sets the marker symbol type.
- autocolorscale
- line
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- autocolorscale
Parent:data[type=scatter3d].line
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scatter3d].line
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.
- cmax
Parent:data[type=scatter3d].line
Type: numberSets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.
- cmid
Parent:data[type=scatter3d].line
Type: numberSets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.
- cmin
Parent:data[type=scatter3d].line
Type: numberSets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.
- color
Parent:data[type=scatter3d].line
Type: color or array of colorsSets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.
- coloraxis
Parent:data[type=scatter3d].line
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=scatter3d].line
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=scatter3d].line.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=scatter3d].line.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=scatter3d].line.colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=scatter3d].line.colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=scatter3d].line.colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=scatter3d].line.colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=scatter3d].line.colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=scatter3d].line.colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=scatter3d].line.colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=scatter3d].line.colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=scatter3d].line.colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=scatter3d].line.colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: color - family
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].line.colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=scatter3d].line.colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=scatter3d].line.colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=scatter3d].line.colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=scatter3d].line.colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=scatter3d].line.colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=scatter3d].line.colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=scatter3d].line.colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=scatter3d].line.colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=scatter3d].line.colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=scatter3d].line.colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=scatter3d].line.colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=scatter3d].line.colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=scatter3d].line.colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scatter3d].line.colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=scatter3d].line.colorbar.title.font
Type: color - family
Parent:data[type=scatter3d].line.colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scatter3d].line.colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter3d].line.colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=scatter3d].line.colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=scatter3d].line.colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter3d].line.colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter3d].line.colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].line.colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=scatter3d].line.colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=scatter3d].line.colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=scatter3d].line.colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=scatter3d].line.colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=scatter3d].line.colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=scatter3d].line.colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- colorscale
Parent:data[type=scatter3d].line
Type: colorscaleSets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- dash
Parent:data[type=scatter3d].line
Type: enumerated , one of ("dash"|"dashdot"|"dot"|"longdash"|"longdashdot"|"solid")
Default:"solid"Sets the dash style of the lines.
- reversescale
Parent:data[type=scatter3d].line
Type: booleanReverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.
- showscale
Parent:data[type=scatter3d].line
Type: booleanDetermines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.
- width
Parent:data[type=scatter3d].line
Type: number greater than or equal to 0
Default:2Sets the line width (in px).
- autocolorscale
- textfont
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.Sets the text font.
- color
Parent:data[type=scatter3d].textfont
Type: color or array of colors - family
Parent:data[type=scatter3d].textfont
Type: string or array of stringsHTML 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.
- size
Parent:data[type=scatter3d].textfont
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=scatter3d].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- variant
Parent:data[type=scatter3d].textfont
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].textfont
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- error_x
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scatter3d].error_x
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scatter3d].error_x
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scatter3d].error_x
Type: colorSets the stroke color of the error bars.
- copy_zstyle
Parent:data[type=scatter3d].error_x
Type: boolean - symmetric
Parent:data[type=scatter3d].error_x
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scatter3d].error_x
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scatter3d].error_x
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scatter3d].error_x
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scatter3d].error_x
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scatter3d].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scatter3d].error_x
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scatter3d].error_x
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scatter3d].error_x
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- error_y
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scatter3d].error_y
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scatter3d].error_y
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scatter3d].error_y
Type: colorSets the stroke color of the error bars.
- copy_zstyle
Parent:data[type=scatter3d].error_y
Type: boolean - symmetric
Parent:data[type=scatter3d].error_y
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scatter3d].error_y
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scatter3d].error_y
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scatter3d].error_y
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scatter3d].error_y
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scatter3d].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scatter3d].error_y
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scatter3d].error_y
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scatter3d].error_y
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- error_z
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- array
Parent:data[type=scatter3d].error_z
Type: data arraySets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
- arrayminus
Parent:data[type=scatter3d].error_z
Type: data arraySets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
- color
Parent:data[type=scatter3d].error_z
Type: colorSets the stroke color of the error bars.
- symmetric
Parent:data[type=scatter3d].error_z
Type: booleanDetermines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
- thickness
Parent:data[type=scatter3d].error_z
Type: number greater than or equal to 0
Default:2Sets the thickness (in px) of the error bars.
- traceref
Parent:data[type=scatter3d].error_z
Type: integer greater than or equal to 0
Default:0 - tracerefminus
Parent:data[type=scatter3d].error_z
Type: integer greater than or equal to 0
Default:0 - type
Parent:data[type=scatter3d].error_z
Type: enumerated , one of ("percent"|"constant"|"sqrt"|"data")Determines the rule used to generate the error bars. If "constant", the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
- value
Parent:data[type=scatter3d].error_z
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
- valueminus
Parent:data[type=scatter3d].error_z
Type: number greater than or equal to 0
Default:10Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
- visible
Parent:data[type=scatter3d].error_z
Type: booleanDetermines whether or not this set of error bars is visible.
- width
Parent:data[type=scatter3d].error_z
Type: number greater than or equal to 0Sets the width (in px) of the cross-bar at both ends of the error bars.
- array
- zhoverformat
Parent:data[type=scatter3d]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- connectgaps
Parent:data[type=scatter3d]
Type: booleanDetermines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
- hoverlabel
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=scatter3d].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=scatter3d].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=scatter3d].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=scatter3d].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=scatter3d].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=scatter3d].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=scatter3d].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scatter3d].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=scatter3d].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=scatter3d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scatter3d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scatter3d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scatter3d].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=scatter3d].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=scatter3d].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- projection
Parent:data[type=scatter3d]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=scatter3d].projection
Type: object containing one or more of the keys listed below.- opacity
Parent:data[type=scatter3d].projection.x
Type: number between or equal to 0 and 1
Default:1Sets the projection color.
- scale
Parent:data[type=scatter3d].projection.x
Type: number between or equal to 0 and 10
Default:0.6666666666666666Sets the scale factor determining the size of the projection marker points.
- show
Parent:data[type=scatter3d].projection.x
Type: booleanSets whether or not projections are shown along the x axis.
- opacity
- y
Parent:data[type=scatter3d].projection
Type: object containing one or more of the keys listed below.- opacity
Parent:data[type=scatter3d].projection.y
Type: number between or equal to 0 and 1
Default:1Sets the projection color.
- scale
Parent:data[type=scatter3d].projection.y
Type: number between or equal to 0 and 10
Default:0.6666666666666666Sets the scale factor determining the size of the projection marker points.
- show
Parent:data[type=scatter3d].projection.y
Type: booleanSets whether or not projections are shown along the y axis.
- opacity
- z
Parent:data[type=scatter3d].projection
Type: object containing one or more of the keys listed below.- opacity
Parent:data[type=scatter3d].projection.z
Type: number between or equal to 0 and 1
Default:1Sets the projection color.
- scale
Parent:data[type=scatter3d].projection.z
Type: number between or equal to 0 and 10
Default:0.6666666666666666Sets the scale factor determining the size of the projection marker points.
- show
Parent:data[type=scatter3d].projection.z
Type: booleanSets whether or not projections are shown along the z axis.
- opacity
- x
- surfaceaxis
Parent:data[type=scatter3d]
Type: enumerated , one of ("-1"|"0"|"1"|"2")
Default:"-1"If "-1", the scatter points are not fill with a surface If "0", "1", "2", the scatter points are filled with a Delaunay surface about the x, y, z respectively.
- xcalendar
Parent:data[type=scatter3d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=scatter3d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- zcalendar
Parent:data[type=scatter3d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `z` date data.
- uirevision
Parent:data[type=scatter3d]
Type: number or categorical coordinate stringControls 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.
surface traces
surface trace is an object with the key "type" equal to "surface" (i.e. {"type": "surface"}) and any of the keys listed below. The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a 2D array. Coordinates in `x` and `y` can either be 1D arrays or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a 2D array, where its bounds can be controlled using `cmin` and `cmax`.
- type
Parent:data[type=surface]
Type: "surface" - name
Parent:data[type=surface]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=surface]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=surface]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=surface]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=surface]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=surface]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=surface]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=surface].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=surface].legendgrouptitle.font
Type: color - family
Parent:data[type=surface].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=surface].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=surface].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=surface].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=surface].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=surface].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=surface].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=surface].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=surface].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=surface]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=surface]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
- ids
Parent:data[type=surface]
Type: data arrayAssigns 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.
- x
Parent:data[type=surface]
Type: data arraySets the x coordinates.
- y
Parent:data[type=surface]
Type: data arraySets the y coordinates.
- z
Parent:data[type=surface]
Type: data arraySets the z coordinates.
- surfacecolor
Parent:data[type=surface]
Type: data arraySets the surface color values, used for setting a color scale independent of `z`.
- text
Parent:data[type=surface]
Type: string or array of strings
Default:""Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- hovertext
Parent:data[type=surface]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=surface]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=surface]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=surface]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=surface]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=surface]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=surface]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=surface]
Type: data arrayAssigns 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
- scene
Parent:data[type=surface]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- coloraxis
Parent:data[type=surface]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=surface]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=surface].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=surface].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=surface].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=surface].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=surface].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=surface].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=surface].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=surface].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=surface].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=surface].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=surface].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=surface].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=surface].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=surface].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=surface].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=surface].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=surface].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=surface].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=surface].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=surface].colorbar.tickfont
Type: color - family
Parent:data[type=surface].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=surface].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=surface].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=surface].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=surface].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=surface].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=surface].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=surface].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=surface].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=surface].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=surface].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=surface].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=surface].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=surface].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=surface].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=surface].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=surface].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=surface].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=surface].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=surface].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=surface].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=surface].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=surface].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=surface].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=surface].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=surface].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=surface].colorbar.title.font
Type: color - family
Parent:data[type=surface].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=surface].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=surface].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=surface].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=surface].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=surface].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=surface].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=surface].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=surface].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=surface].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=surface].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=surface].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=surface].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=surface].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=surface].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=surface].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=surface].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=surface]
Type: booleanDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=surface]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=surface]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=surface]
Type: booleanReverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
- zhoverformat
Parent:data[type=surface]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- cauto
Parent:data[type=surface]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
- cmax
Parent:data[type=surface]
Type: numberSets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.
- cmid
Parent:data[type=surface]
Type: numberSets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `false`.
- cmin
Parent:data[type=surface]
Type: numberSets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.
- connectgaps
Parent:data[type=surface]
Type: booleanDetermines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
- contours
Parent:data[type=surface]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=surface].contours
Type: object containing one or more of the keys listed below.- color
Parent:data[type=surface].contours.x
Type: color
Default:"#444"Sets the color of the contour lines.
- end
Parent:data[type=surface].contours.x
Type: numberSets the end contour level value. Must be more than `contours.start`
- highlight
Parent:data[type=surface].contours.x
Type: boolean
Default:trueDetermines whether or not contour lines about the x dimension are highlighted on hover.
- highlightcolor
Parent:data[type=surface].contours.x
Type: color
Default:"#444"Sets the color of the highlighted contour lines.
- highlightwidth
Parent:data[type=surface].contours.x
Type: number between or equal to 1 and 16
Default:2Sets the width of the highlighted contour lines.
- project
Parent:data[type=surface].contours.x
Type: object containing one or more of the keys listed below.- x
Parent:data[type=surface].contours.x.project
Type: booleanDetermines whether or not these contour lines are projected on the x plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- y
Parent:data[type=surface].contours.x.project
Type: booleanDetermines whether or not these contour lines are projected on the y plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- z
Parent:data[type=surface].contours.x.project
Type: booleanDetermines whether or not these contour lines are projected on the z plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- x
- show
Parent:data[type=surface].contours.x
Type: booleanDetermines whether or not contour lines about the x dimension are drawn.
- size
Parent:data[type=surface].contours.x
Type: number greater than or equal to 0Sets the step between each contour level. Must be positive.
- start
Parent:data[type=surface].contours.x
Type: numberSets the starting contour level value. Must be less than `contours.end`
- usecolormap
Parent:data[type=surface].contours.x
Type: booleanAn alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
- width
Parent:data[type=surface].contours.x
Type: number between or equal to 1 and 16
Default:2Sets the width of the contour lines.
- color
- y
Parent:data[type=surface].contours
Type: object containing one or more of the keys listed below.- color
Parent:data[type=surface].contours.y
Type: color
Default:"#444"Sets the color of the contour lines.
- end
Parent:data[type=surface].contours.y
Type: numberSets the end contour level value. Must be more than `contours.start`
- highlight
Parent:data[type=surface].contours.y
Type: boolean
Default:trueDetermines whether or not contour lines about the y dimension are highlighted on hover.
- highlightcolor
Parent:data[type=surface].contours.y
Type: color
Default:"#444"Sets the color of the highlighted contour lines.
- highlightwidth
Parent:data[type=surface].contours.y
Type: number between or equal to 1 and 16
Default:2Sets the width of the highlighted contour lines.
- project
Parent:data[type=surface].contours.y
Type: object containing one or more of the keys listed below.- x
Parent:data[type=surface].contours.y.project
Type: booleanDetermines whether or not these contour lines are projected on the x plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- y
Parent:data[type=surface].contours.y.project
Type: booleanDetermines whether or not these contour lines are projected on the y plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- z
Parent:data[type=surface].contours.y.project
Type: booleanDetermines whether or not these contour lines are projected on the z plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- x
- show
Parent:data[type=surface].contours.y
Type: booleanDetermines whether or not contour lines about the y dimension are drawn.
- size
Parent:data[type=surface].contours.y
Type: number greater than or equal to 0Sets the step between each contour level. Must be positive.
- start
Parent:data[type=surface].contours.y
Type: numberSets the starting contour level value. Must be less than `contours.end`
- usecolormap
Parent:data[type=surface].contours.y
Type: booleanAn alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
- width
Parent:data[type=surface].contours.y
Type: number between or equal to 1 and 16
Default:2Sets the width of the contour lines.
- color
- z
Parent:data[type=surface].contours
Type: object containing one or more of the keys listed below.- color
Parent:data[type=surface].contours.z
Type: color
Default:"#444"Sets the color of the contour lines.
- end
Parent:data[type=surface].contours.z
Type: numberSets the end contour level value. Must be more than `contours.start`
- highlight
Parent:data[type=surface].contours.z
Type: boolean
Default:trueDetermines whether or not contour lines about the z dimension are highlighted on hover.
- highlightcolor
Parent:data[type=surface].contours.z
Type: color
Default:"#444"Sets the color of the highlighted contour lines.
- highlightwidth
Parent:data[type=surface].contours.z
Type: number between or equal to 1 and 16
Default:2Sets the width of the highlighted contour lines.
- project
Parent:data[type=surface].contours.z
Type: object containing one or more of the keys listed below.- x
Parent:data[type=surface].contours.z.project
Type: booleanDetermines whether or not these contour lines are projected on the x plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- y
Parent:data[type=surface].contours.z.project
Type: booleanDetermines whether or not these contour lines are projected on the y plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- z
Parent:data[type=surface].contours.z.project
Type: booleanDetermines whether or not these contour lines are projected on the z plane. If `highlight` is set to "true" (the default), the projected lines are shown on hover. If `show` is set to "true", the projected lines are shown in permanence.
- x
- show
Parent:data[type=surface].contours.z
Type: booleanDetermines whether or not contour lines about the z dimension are drawn.
- size
Parent:data[type=surface].contours.z
Type: number greater than or equal to 0Sets the step between each contour level. Must be positive.
- start
Parent:data[type=surface].contours.z
Type: numberSets the starting contour level value. Must be less than `contours.end`
- usecolormap
Parent:data[type=surface].contours.z
Type: booleanAn alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
- width
Parent:data[type=surface].contours.z
Type: number between or equal to 1 and 16
Default:2Sets the width of the contour lines.
- color
- x
- hidesurface
Parent:data[type=surface]
Type: booleanDetermines whether or not a surface is drawn. For example, set `hidesurface` to "false" `contours.x.show` to "true" and `contours.y.show` to "true" to draw a wire frame plot.
- hoverlabel
Parent:data[type=surface]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=surface].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=surface].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=surface].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=surface].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=surface].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=surface].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=surface].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=surface].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=surface].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=surface].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=surface].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=surface].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=surface].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=surface].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=surface].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- lighting
Parent:data[type=surface]
Type: object containing one or more of the keys listed below.- ambient
Parent:data[type=surface].lighting
Type: number between or equal to 0 and 1
Default:0.8Ambient light increases overall color visibility but can wash out the image.
- diffuse
Parent:data[type=surface].lighting
Type: number between or equal to 0 and 1
Default:0.8Represents the extent that incident rays are reflected in a range of angles.
- fresnel
Parent:data[type=surface].lighting
Type: number between or equal to 0 and 5
Default:0.2Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Parent:data[type=surface].lighting
Type: number between or equal to 0 and 1
Default:0.5Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Parent:data[type=surface].lighting
Type: number between or equal to 0 and 2
Default:0.05Represents the level that incident rays are reflected in a single direction, causing shine.
- ambient
- lightposition
Parent:data[type=surface]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=surface].lightposition
Type: number between or equal to -100000 and 100000
Default:10Numeric vector, representing the X coordinate for each vertex.
- y
Parent:data[type=surface].lightposition
Type: number between or equal to -100000 and 100000
Default:10000Numeric vector, representing the Y coordinate for each vertex.
- z
Parent:data[type=surface].lightposition
Type: number between or equal to -100000 and 100000
Default:0Numeric vector, representing the Z coordinate for each vertex.
- x
- opacityscale
Parent:data[type=surface]
Type: number or categorical coordinate stringSets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
- xcalendar
Parent:data[type=surface]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=surface]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- zcalendar
Parent:data[type=surface]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `z` date data.
- uirevision
Parent:data[type=surface]
Type: number or categorical coordinate stringControls 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.
mesh3d traces
mesh3d trace is an object with the key "type" equal to "mesh3d" (i.e. {"type": "mesh3d"}) and any of the keys listed below. Draws sets of triangles with coordinates given by three 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-shape algorithm or (4) the Convex-hull algorithm
- type
Parent:data[type=mesh3d]
Type: "mesh3d" - name
Parent:data[type=mesh3d]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=mesh3d]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=mesh3d]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=mesh3d]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=mesh3d]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=mesh3d]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=mesh3d]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=mesh3d].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=mesh3d].legendgrouptitle.font
Type: color - family
Parent:data[type=mesh3d].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=mesh3d].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=mesh3d].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=mesh3d].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=mesh3d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=mesh3d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=mesh3d].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=mesh3d].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=mesh3d].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=mesh3d]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=mesh3d]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
- ids
Parent:data[type=mesh3d]
Type: data arrayAssigns 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.
- x
Parent:data[type=mesh3d]
Type: data arraySets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
- y
Parent:data[type=mesh3d]
Type: data arraySets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
- z
Parent:data[type=mesh3d]
Type: data arraySets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
- i
Parent:data[type=mesh3d]
Type: data arrayA vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "first" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle.
- j
Parent:data[type=mesh3d]
Type: data arrayA vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "second" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle.
- k
Parent:data[type=mesh3d]
Type: data arrayA vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "third" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle.
- facecolor
Parent:data[type=mesh3d]
Type: data arraySets the color of each face Overrides "color" and "vertexcolor".
- intensity
Parent:data[type=mesh3d]
Type: data arraySets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes.
- intensitymode
Parent:data[type=mesh3d]
Type: enumerated , one of ("vertex"|"cell")
Default:"vertex"Determines the source of `intensity` values.
- vertexcolor
Parent:data[type=mesh3d]
Type: data arraySets the color of each vertex Overrides "color". While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.
- text
Parent:data[type=mesh3d]
Type: string or array of strings
Default:""Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- hovertext
Parent:data[type=mesh3d]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=mesh3d]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=mesh3d]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=mesh3d]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=mesh3d]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=mesh3d]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- meta
Parent:data[type=mesh3d]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=mesh3d]
Type: data arrayAssigns 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
- scene
Parent:data[type=mesh3d]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- coloraxis
Parent:data[type=mesh3d]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- color
Parent:data[type=mesh3d]
Type: colorSets the color of the whole mesh
- colorbar
Parent:data[type=mesh3d]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=mesh3d].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=mesh3d].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=mesh3d].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=mesh3d].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=mesh3d].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=mesh3d].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=mesh3d].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=mesh3d].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=mesh3d].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=mesh3d].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=mesh3d].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=mesh3d].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=mesh3d].colorbar.tickfont
Type: color - family
Parent:data[type=mesh3d].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=mesh3d].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=mesh3d].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=mesh3d].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=mesh3d].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=mesh3d].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=mesh3d].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=mesh3d].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=mesh3d].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=mesh3d].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=mesh3d].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=mesh3d].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=mesh3d].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=mesh3d].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=mesh3d].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=mesh3d].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=mesh3d].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=mesh3d].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=mesh3d].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=mesh3d].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=mesh3d].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=mesh3d].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=mesh3d].colorbar.title.font
Type: color - family
Parent:data[type=mesh3d].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=mesh3d].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=mesh3d].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=mesh3d].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=mesh3d].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=mesh3d].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=mesh3d].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=mesh3d].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=mesh3d].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=mesh3d].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=mesh3d].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=mesh3d].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=mesh3d].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=mesh3d].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=mesh3d]
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=mesh3d]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=mesh3d]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=mesh3d]
Type: booleanReverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
- zhoverformat
Parent:data[type=mesh3d]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- cauto
Parent:data[type=mesh3d]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
- cmax
Parent:data[type=mesh3d]
Type: numberSets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well.
- cmid
Parent:data[type=mesh3d]
Type: numberSets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`.
- cmin
Parent:data[type=mesh3d]
Type: numberSets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.
- alphahull
Parent:data[type=mesh3d]
Type: number
Default:-1Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If "-1", Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If "0", the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull.
- delaunayaxis
Parent:data[type=mesh3d]
Type: enumerated , one of ("x"|"y"|"z")
Default:"z"Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.
- contour
Parent:data[type=mesh3d]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=mesh3d].contour
Type: color
Default:"#444"Sets the color of the contour lines.
- show
Parent:data[type=mesh3d].contour
Type: booleanSets whether or not dynamic contours are shown on hover
- width
Parent:data[type=mesh3d].contour
Type: number between or equal to 1 and 16
Default:2Sets the width of the contour lines.
- color
- flatshading
Parent:data[type=mesh3d]
Type: booleanDetermines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
- hoverlabel
Parent:data[type=mesh3d]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=mesh3d].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=mesh3d].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=mesh3d].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=mesh3d].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=mesh3d].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=mesh3d].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=mesh3d].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=mesh3d].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=mesh3d].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=mesh3d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=mesh3d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=mesh3d].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=mesh3d].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=mesh3d].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=mesh3d].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- lighting
Parent:data[type=mesh3d]
Type: object containing one or more of the keys listed below.- ambient
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 1
Default:0.8Ambient light increases overall color visibility but can wash out the image.
- diffuse
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 1
Default:0.8Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 1
Default:1e-06Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 5
Default:0.2Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 1
Default:0.5Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 2
Default:0.05Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Parent:data[type=mesh3d].lighting
Type: number between or equal to 0 and 1
Default:1e-12Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
- ambient
- lightposition
Parent:data[type=mesh3d]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=mesh3d].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the X coordinate for each vertex.
- y
Parent:data[type=mesh3d].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the Y coordinate for each vertex.
- z
Parent:data[type=mesh3d].lightposition
Type: number between or equal to -100000 and 100000
Default:0Numeric vector, representing the Z coordinate for each vertex.
- x
- xcalendar
Parent:data[type=mesh3d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `x` date data.
- ycalendar
Parent:data[type=mesh3d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `y` date data.
- zcalendar
Parent:data[type=mesh3d]
Type: enumerated , one of ("chinese"|"coptic"|"discworld"|"ethiopian"|"gregorian"|"hebrew"|"islamic"|"jalali"|"julian"|"mayan"|"nanakshahi"|"nepali"|"persian"|"taiwan"|"thai"|"ummalqura")
Default:"gregorian"Sets the calendar system to use with `z` date data.
- uirevision
Parent:data[type=mesh3d]
Type: number or categorical coordinate stringControls 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.
cone traces
cone trace is an object with the key "type" equal to "cone" (i.e. {"type": "cone"}) and any of the keys listed below. Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, `w`. The cones are drawn exactly at the positions given by `x`, `y` and `z`.
- type
Parent:data[type=cone]
Type: "cone" - name
Parent:data[type=cone]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=cone]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=cone]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=cone]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=cone]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=cone]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=cone]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=cone].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=cone].legendgrouptitle.font
Type: color - family
Parent:data[type=cone].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=cone].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=cone].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=cone].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=cone].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=cone].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=cone].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=cone].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=cone].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=cone]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=cone]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
- ids
Parent:data[type=cone]
Type: data arrayAssigns 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.
- x
Parent:data[type=cone]
Type: data arraySets the x coordinates of the vector field and of the displayed cones.
- y
Parent:data[type=cone]
Type: data arraySets the y coordinates of the vector field and of the displayed cones.
- z
Parent:data[type=cone]
Type: data arraySets the z coordinates of the vector field and of the displayed cones.
- u
Parent:data[type=cone]
Type: data arraySets the x components of the vector field.
- v
Parent:data[type=cone]
Type: data arraySets the y components of the vector field.
- w
Parent:data[type=cone]
Type: data arraySets the z components of the vector field.
- text
Parent:data[type=cone]
Type: string or array of strings
Default:""Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- hovertext
Parent:data[type=cone]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=cone]
Type: flaglist string. Any combination of"x","y","z","u","v","w","norm","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"x+y+z+norm+text+name"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=cone]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `norm` Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=cone]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=cone]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=cone]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- uhoverformat
Parent:data[type=cone]
Type: string
Default:""Sets the hover text formatting rulefor `u` 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.By default the values are formatted using generic number format.
- vhoverformat
Parent:data[type=cone]
Type: string
Default:""Sets the hover text formatting rulefor `v` 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.By default the values are formatted using generic number format.
- whoverformat
Parent:data[type=cone]
Type: string
Default:""Sets the hover text formatting rulefor `w` 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.By default the values are formatted using generic number format.
- meta
Parent:data[type=cone]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=cone]
Type: data arrayAssigns 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
- scene
Parent:data[type=cone]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- coloraxis
Parent:data[type=cone]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=cone]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=cone].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=cone].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=cone].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=cone].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=cone].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=cone].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=cone].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=cone].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=cone].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=cone].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=cone].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=cone].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=cone].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=cone].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=cone].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=cone].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=cone].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=cone].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=cone].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=cone].colorbar.tickfont
Type: color - family
Parent:data[type=cone].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=cone].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=cone].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=cone].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=cone].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=cone].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=cone].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=cone].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=cone].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=cone].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=cone].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=cone].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=cone].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=cone].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=cone].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=cone].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=cone].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=cone].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=cone].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=cone].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=cone].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=cone].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=cone].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=cone].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=cone].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=cone].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=cone].colorbar.title.font
Type: color - family
Parent:data[type=cone].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=cone].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=cone].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=cone].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=cone].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=cone].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=cone].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=cone].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=cone].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=cone].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=cone].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=cone].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=cone].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=cone].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=cone].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=cone].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=cone].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=cone]
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=cone]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=cone]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=cone]
Type: booleanReverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
- zhoverformat
Parent:data[type=cone]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- cauto
Parent:data[type=cone]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
- cmax
Parent:data[type=cone]
Type: numberSets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.
- cmid
Parent:data[type=cone]
Type: numberSets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.
- cmin
Parent:data[type=cone]
Type: numberSets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.
- anchor
Parent:data[type=cone]
Type: enumerated , one of ("tip"|"tail"|"cm"|"center")
Default:"cm"Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip.
- hoverlabel
Parent:data[type=cone]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=cone].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=cone].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=cone].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=cone].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=cone].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=cone].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=cone].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=cone].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=cone].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=cone].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=cone].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=cone].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=cone].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=cone].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=cone].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- lighting
Parent:data[type=cone]
Type: object containing one or more of the keys listed below.- ambient
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 1
Default:0.8Ambient light increases overall color visibility but can wash out the image.
- diffuse
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 1
Default:0.8Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 1
Default:1e-06Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 5
Default:0.2Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 1
Default:0.5Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 2
Default:0.05Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Parent:data[type=cone].lighting
Type: number between or equal to 0 and 1
Default:1e-12Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
- ambient
- lightposition
Parent:data[type=cone]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=cone].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the X coordinate for each vertex.
- y
Parent:data[type=cone].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the Y coordinate for each vertex.
- z
Parent:data[type=cone].lightposition
Type: number between or equal to -100000 and 100000
Default:0Numeric vector, representing the Z coordinate for each vertex.
- x
- sizemode
Parent:data[type=cone]
Type: enumerated , one of ("scaled"|"absolute"|"raw")
Default:"scaled"Determines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field). To display sizes in actual vector length use "raw".
- sizeref
Parent:data[type=cone]
Type: number greater than or equal to 0Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to "raw", its default value is "1". With `sizemode` set to "scaled", `sizeref` is unitless, its default value is "0.5". With `sizemode` set to "absolute", `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.
- uirevision
Parent:data[type=cone]
Type: number or categorical coordinate stringControls 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.
streamtube traces
streamtube trace is an object with the key "type" equal to "streamtube" (i.e. {"type": "streamtube"}) and any of the keys listed below. Use a streamtube trace to visualize flow in a vector field. Specify a vector field using 6 1D arrays of equal length, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, and `w`. By default, the tubes' starting positions will be cut from the vector field's x-z plane at its minimum y value. To specify your own starting position, use attributes `starts.x`, `starts.y` and `starts.z`. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w).
- type
Parent:data[type=streamtube]
Type: "streamtube" - name
Parent:data[type=streamtube]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=streamtube]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=streamtube]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=streamtube]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=streamtube]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=streamtube]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=streamtube]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=streamtube].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=streamtube].legendgrouptitle.font
Type: color - family
Parent:data[type=streamtube].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=streamtube].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=streamtube].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=streamtube].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=streamtube].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=streamtube].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=streamtube].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=streamtube].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=streamtube].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=streamtube]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=streamtube]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
- ids
Parent:data[type=streamtube]
Type: data arrayAssigns 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.
- x
Parent:data[type=streamtube]
Type: data arraySets the x coordinates of the vector field.
- y
Parent:data[type=streamtube]
Type: data arraySets the y coordinates of the vector field.
- z
Parent:data[type=streamtube]
Type: data arraySets the z coordinates of the vector field.
- u
Parent:data[type=streamtube]
Type: data arraySets the x components of the vector field.
- v
Parent:data[type=streamtube]
Type: data arraySets the y components of the vector field.
- w
Parent:data[type=streamtube]
Type: data arraySets the z components of the vector field.
- text
Parent:data[type=streamtube]
Type: string
Default:""Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values.
- hovertext
Parent:data[type=streamtube]
Type: string
Default:""Same as `text`.
- hoverinfo
Parent:data[type=streamtube]
Type: flaglist string. Any combination of"x","y","z","u","v","w","norm","divergence","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"x+y+z+norm+text+name"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=streamtube]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=streamtube]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=streamtube]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=streamtube]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- uhoverformat
Parent:data[type=streamtube]
Type: string
Default:""Sets the hover text formatting rulefor `u` 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.By default the values are formatted using generic number format.
- vhoverformat
Parent:data[type=streamtube]
Type: string
Default:""Sets the hover text formatting rulefor `v` 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.By default the values are formatted using generic number format.
- whoverformat
Parent:data[type=streamtube]
Type: string
Default:""Sets the hover text formatting rulefor `w` 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.By default the values are formatted using generic number format.
- meta
Parent:data[type=streamtube]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=streamtube]
Type: data arrayAssigns 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
- scene
Parent:data[type=streamtube]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- coloraxis
Parent:data[type=streamtube]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=streamtube]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=streamtube].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=streamtube].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=streamtube].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=streamtube].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=streamtube].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=streamtube].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=streamtube].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=streamtube].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=streamtube].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=streamtube].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=streamtube].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=streamtube].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=streamtube].colorbar.tickfont
Type: color - family
Parent:data[type=streamtube].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=streamtube].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=streamtube].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=streamtube].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=streamtube].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=streamtube].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=streamtube].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=streamtube].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=streamtube].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=streamtube].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=streamtube].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=streamtube].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=streamtube].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=streamtube].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=streamtube].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=streamtube].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=streamtube].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=streamtube].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=streamtube].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=streamtube].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=streamtube].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=streamtube].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=streamtube].colorbar.title.font
Type: color - family
Parent:data[type=streamtube].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=streamtube].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=streamtube].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=streamtube].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=streamtube].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=streamtube].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=streamtube].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=streamtube].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=streamtube].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=streamtube].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=streamtube].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=streamtube].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=streamtube].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=streamtube].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=streamtube]
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=streamtube]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=streamtube]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=streamtube]
Type: booleanReverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
- zhoverformat
Parent:data[type=streamtube]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- cauto
Parent:data[type=streamtube]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
- cmax
Parent:data[type=streamtube]
Type: numberSets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.
- cmid
Parent:data[type=streamtube]
Type: numberSets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.
- cmin
Parent:data[type=streamtube]
Type: numberSets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.
- hoverlabel
Parent:data[type=streamtube]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=streamtube].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=streamtube].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=streamtube].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=streamtube].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=streamtube].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=streamtube].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=streamtube].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=streamtube].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=streamtube].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=streamtube].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=streamtube].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=streamtube].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=streamtube].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=streamtube].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=streamtube].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- lighting
Parent:data[type=streamtube]
Type: object containing one or more of the keys listed below.- ambient
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 1
Default:0.8Ambient light increases overall color visibility but can wash out the image.
- diffuse
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 1
Default:0.8Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 1
Default:1e-06Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 5
Default:0.2Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 1
Default:0.5Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 2
Default:0.05Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Parent:data[type=streamtube].lighting
Type: number between or equal to 0 and 1
Default:1e-12Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
- ambient
- lightposition
Parent:data[type=streamtube]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=streamtube].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the X coordinate for each vertex.
- y
Parent:data[type=streamtube].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the Y coordinate for each vertex.
- z
Parent:data[type=streamtube].lightposition
Type: number between or equal to -100000 and 100000
Default:0Numeric vector, representing the Z coordinate for each vertex.
- x
- maxdisplayed
Parent:data[type=streamtube]
Type: integer greater than or equal to 0
Default:1000The maximum number of displayed segments in a streamtube.
- sizeref
Parent:data[type=streamtube]
Type: number greater than or equal to 0
Default:1The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.
- starts
Parent:data[type=streamtube]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=streamtube].starts
Type: data arraySets the x components of the starting position of the streamtubes
- y
Parent:data[type=streamtube].starts
Type: data arraySets the y components of the starting position of the streamtubes
- z
Parent:data[type=streamtube].starts
Type: data arraySets the z components of the starting position of the streamtubes
- x
- uirevision
Parent:data[type=streamtube]
Type: number or categorical coordinate stringControls 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.
volume traces
volume trace is an object with the key "type" equal to "volume" (i.e. {"type": "volume"}) and any of the keys listed below. Draws volume trace between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non-uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace.
- type
Parent:data[type=volume]
Type: "volume" - name
Parent:data[type=volume]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=volume]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=volume]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=volume]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=volume]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=volume]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=volume].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=volume].legendgrouptitle.font
Type: color - family
Parent:data[type=volume].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=volume].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=volume].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=volume].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=volume].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=volume].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=volume].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=volume].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=volume].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=volume]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=volume]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
- ids
Parent:data[type=volume]
Type: data arrayAssigns 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.
- x
Parent:data[type=volume]
Type: data arraySets the X coordinates of the vertices on X axis.
- y
Parent:data[type=volume]
Type: data arraySets the Y coordinates of the vertices on Y axis.
- z
Parent:data[type=volume]
Type: data arraySets the Z coordinates of the vertices on Z axis.
- value
Parent:data[type=volume]
Type: data arraySets the 4th dimension (value) of the vertices.
- text
Parent:data[type=volume]
Type: string or array of strings
Default:""Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- hovertext
Parent:data[type=volume]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=volume]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=volume]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=volume]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=volume]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=volume]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- valuehoverformat
Parent:data[type=volume]
Type: string
Default:""Sets the hover text formatting rulefor `value` 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.By default the values are formatted using generic number format.
- meta
Parent:data[type=volume]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=volume]
Type: data arrayAssigns 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
- scene
Parent:data[type=volume]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- coloraxis
Parent:data[type=volume]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=volume].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=volume].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=volume].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=volume].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=volume].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=volume].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=volume].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=volume].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=volume].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=volume].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=volume].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=volume].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=volume].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=volume].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=volume].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=volume].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=volume].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=volume].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=volume].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=volume].colorbar.tickfont
Type: color - family
Parent:data[type=volume].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=volume].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=volume].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=volume].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=volume].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=volume].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=volume].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=volume].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=volume].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=volume].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=volume].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=volume].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=volume].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=volume].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=volume].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=volume].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=volume].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=volume].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=volume].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=volume].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=volume].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=volume].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=volume].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=volume].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=volume].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=volume].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=volume].colorbar.title.font
Type: color - family
Parent:data[type=volume].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=volume].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=volume].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=volume].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=volume].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=volume].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=volume].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=volume].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=volume].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=volume].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=volume].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=volume].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=volume].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=volume].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=volume].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=volume].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=volume].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=volume]
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=volume]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=volume]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=volume]
Type: booleanReverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
- zhoverformat
Parent:data[type=volume]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- cauto
Parent:data[type=volume]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
- cmax
Parent:data[type=volume]
Type: numberSets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.
- cmid
Parent:data[type=volume]
Type: numberSets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.
- cmin
Parent:data[type=volume]
Type: numberSets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.
- caps
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=volume].caps
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].caps.x
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=volume].caps.x
Type: boolean
Default:trueSets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- fill
- y
Parent:data[type=volume].caps
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].caps.y
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=volume].caps.y
Type: boolean
Default:trueSets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- fill
- z
Parent:data[type=volume].caps
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].caps.z
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=volume].caps.z
Type: boolean
Default:trueSets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- fill
- x
- contour
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=volume].contour
Type: color
Default:"#444"Sets the color of the contour lines.
- show
Parent:data[type=volume].contour
Type: booleanSets whether or not dynamic contours are shown on hover
- width
Parent:data[type=volume].contour
Type: number between or equal to 1 and 16
Default:2Sets the width of the contour lines.
- color
- flatshading
Parent:data[type=volume]
Type: boolean
Default:trueDetermines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
- hoverlabel
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=volume].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=volume].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=volume].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=volume].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=volume].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=volume].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=volume].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=volume].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=volume].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=volume].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=volume].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=volume].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=volume].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=volume].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=volume].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- isomax
Parent:data[type=volume]
Type: numberSets the maximum boundary for iso-surface plot.
- isomin
Parent:data[type=volume]
Type: numberSets the minimum boundary for iso-surface plot.
- lighting
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- ambient
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 1
Default:0.8Ambient light increases overall color visibility but can wash out the image.
- diffuse
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 1
Default:0.8Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 1
Default:0Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 5
Default:0.2Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 1
Default:0.5Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 2
Default:0.05Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Parent:data[type=volume].lighting
Type: number between or equal to 0 and 1
Default:1e-12Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
- ambient
- lightposition
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=volume].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the X coordinate for each vertex.
- y
Parent:data[type=volume].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the Y coordinate for each vertex.
- z
Parent:data[type=volume].lightposition
Type: number between or equal to -100000 and 100000
Default:0Numeric vector, representing the Z coordinate for each vertex.
- x
- opacityscale
Parent:data[type=volume]
Type: number or categorical coordinate stringSets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
- slices
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=volume].slices
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].slices.x
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- locations
Parent:data[type=volume].slices.x
Type: data array
Default:Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
- show
Parent:data[type=volume].slices.x
Type: booleanDetermines whether or not slice planes about the x dimension are drawn.
- fill
- y
Parent:data[type=volume].slices
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].slices.y
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- locations
Parent:data[type=volume].slices.y
Type: data array
Default:Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
- show
Parent:data[type=volume].slices.y
Type: booleanDetermines whether or not slice planes about the y dimension are drawn.
- fill
- z
Parent:data[type=volume].slices
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].slices.z
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- locations
Parent:data[type=volume].slices.z
Type: data array
Default:Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
- show
Parent:data[type=volume].slices.z
Type: booleanDetermines whether or not slice planes about the z dimension are drawn.
- fill
- x
- spaceframe
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=volume].spaceframe
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely shaded. Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=volume].spaceframe
Type: booleanDisplays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
- fill
- surface
Parent:data[type=volume]
Type: object containing one or more of the keys listed below.- count
Parent:data[type=volume].surface
Type: integer greater than or equal to 1
Default:2Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
- fill
Parent:data[type=volume].surface
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- pattern
Parent:data[type=volume].surface
Type: flaglist string. Any combination of"A","B","C","D","E"joined with a"+"OR"all"or"odd"or"even".
Examples:"A","B","A+B","A+B+C","all"
Default:"all"Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
- show
Parent:data[type=volume].surface
Type: boolean
Default:trueHides/displays surfaces between minimum and maximum iso-values.
- count
- uirevision
Parent:data[type=volume]
Type: number or categorical coordinate stringControls 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.
isosurface traces
isosurface trace is an object with the key "type" equal to "isosurface" (i.e. {"type": "isosurface"}) and any of the keys listed below. Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non-uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace.
- type
Parent:data[type=isosurface]
Type: "isosurface" - name
Parent:data[type=isosurface]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=isosurface]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=isosurface]
Type: booleanDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=isosurface]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=isosurface]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=isosurface]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=isosurface].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=isosurface].legendgrouptitle.font
Type: color - family
Parent:data[type=isosurface].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=isosurface].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=isosurface].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=isosurface].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=isosurface].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=isosurface].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=isosurface].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=isosurface].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=isosurface].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=isosurface]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=isosurface]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
- ids
Parent:data[type=isosurface]
Type: data arrayAssigns 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.
- x
Parent:data[type=isosurface]
Type: data arraySets the X coordinates of the vertices on X axis.
- y
Parent:data[type=isosurface]
Type: data arraySets the Y coordinates of the vertices on Y axis.
- z
Parent:data[type=isosurface]
Type: data arraySets the Z coordinates of the vertices on Z axis.
- value
Parent:data[type=isosurface]
Type: data arraySets the 4th dimension (value) of the vertices.
- text
Parent:data[type=isosurface]
Type: string or array of strings
Default:""Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- hovertext
Parent:data[type=isosurface]
Type: string or array of strings
Default:""Same as `text`.
- hoverinfo
Parent:data[type=isosurface]
Type: flaglist string. Any combination of"x","y","z","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"x","y","x+y","x+y+z","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=isosurface]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=isosurface]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- xhoverformat
Parent:data[type=isosurface]
Type: string
Default:""Sets the hover text formatting rulefor `x` 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"By default the values are formatted using `xaxis.hoverformat`.
- yhoverformat
Parent:data[type=isosurface]
Type: string
Default:""Sets the hover text formatting rulefor `y` 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"By default the values are formatted using `yaxis.hoverformat`.
- valuehoverformat
Parent:data[type=isosurface]
Type: string
Default:""Sets the hover text formatting rulefor `value` 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.By default the values are formatted using generic number format.
- meta
Parent:data[type=isosurface]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=isosurface]
Type: data arrayAssigns 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
- scene
Parent:data[type=isosurface]
Type: subplotid
Default:sceneSets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
- coloraxis
Parent:data[type=isosurface]
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=isosurface].colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=isosurface].colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=isosurface].colorbar
Type: number or categorical coordinate stringSets 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"
- exponentformat
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("none"|"e"|"E"|"power"|"SI"|"B"|"SI extended")
Default:"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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.
- labelalias
Parent:data[type=isosurface].colorbar
Type: number or categorical coordinate stringReplacement 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.
- len
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:1Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- lenmode
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"fraction"Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
- minexponent
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:3Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
- nticks
Parent:data[type=isosurface].colorbar
Type: integer greater than or equal to 0
Default:0Specifies 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".
- orientation
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("h"|"v")
Default:"v"Sets the orientation of the colorbar.
- outlinecolor
Parent:data[type=isosurface].colorbar
Type: color
Default:"#444"Sets the axis line color.
- outlinewidth
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:1Sets the width (in px) of the axis line.
- separatethousands
Parent:data[type=isosurface].colorbar
Type: booleanIf "true", even 4-digit integers are separated
- showexponent
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticklabels
Parent:data[type=isosurface].colorbar
Type: boolean
Default:trueDetermines whether or not the tick labels are drawn.
- showtickprefix
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"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.
- showticksuffix
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("all"|"first"|"last"|"none")
Default:"all"Same as `showtickprefix` but for tick suffixes.
- thickness
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:30Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("fraction"|"pixels")
Default:"pixels"Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
- tick0
Parent:data[type=isosurface].colorbar
Type: number or categorical coordinate stringSets 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.
- tickangle
Parent:data[type=isosurface].colorbar
Type: angle
Default:"auto"Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
- tickcolor
Parent:data[type=isosurface].colorbar
Type: color
Default:"#444"Sets the tick color.
- tickfont
Parent:data[type=isosurface].colorbar
Type: object containing one or more of the keys listed below.Sets the color bar's tick label font
- color
Parent:data[type=isosurface].colorbar.tickfont
Type: color - family
Parent:data[type=isosurface].colorbar.tickfont
Type: stringHTML 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.
- lineposition
Parent:data[type=isosurface].colorbar.tickfont
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=isosurface].colorbar.tickfont
Type: string
Default:"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.
- size
Parent:data[type=isosurface].colorbar.tickfont
Type: number greater than or equal to 1 - style
Parent:data[type=isosurface].colorbar.tickfont
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=isosurface].colorbar.tickfont
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=isosurface].colorbar.tickfont
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=isosurface].colorbar.tickfont
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- tickformat
Parent:data[type=isosurface].colorbar
Type: string
Default:""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"
- tickformatstops
Parent:data[type=isosurface].colorbar
Type: array of object where each object has one or more of the keys listed below.- dtickrange
Parent:data[type=isosurface].colorbar.tickformatstops[]
Type: arrayrange ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
- enabled
Parent:data[type=isosurface].colorbar.tickformatstops[]
Type: boolean
Default:trueDetermines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.
- name
Parent:data[type=isosurface].colorbar.tickformatstops[]
Type: stringWhen 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
Parent:data[type=isosurface].colorbar.tickformatstops[]
Type: stringUsed 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`.
- value
Parent:data[type=isosurface].colorbar.tickformatstops[]
Type: string
Default:""string - dtickformat for described zoom level, the same as "tickformat"
- dtickrange
- ticklabeloverflow
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("allow"|"hide past div"|"hide past domain")Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
- ticklabelposition
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("outside"|"inside"|"outside top"|"inside top"|"outside left"|"inside left"|"outside right"|"inside right"|"outside bottom"|"inside bottom")
Default:"outside"Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is "h", top and bottom when `orientation` is "v".
- ticklabelstep
Parent:data[type=isosurface].colorbar
Type: integer greater than or equal to 1
Default:1Sets 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".
- ticklen
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:5Sets the tick length (in px).
- tickmode
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("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).
- tickprefix
Parent:data[type=isosurface].colorbar
Type: string
Default:""Sets a tick label prefix.
- ticks
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("outside"|"inside"|"")
Default:""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.
- ticksuffix
Parent:data[type=isosurface].colorbar
Type: string
Default:""Sets a tick label suffix.
- ticktext
Parent:data[type=isosurface].colorbar
Type: data arraySets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
- tickvals
Parent:data[type=isosurface].colorbar
Type: data arraySets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
- tickwidth
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:1Sets the tick width (in px).
- title
Parent:data[type=isosurface].colorbar
Type: object containing one or more of the keys listed below.- font
Parent:data[type=isosurface].colorbar.title
Type: object containing one or more of the keys listed below.Sets this color bar's title font.
- color
Parent:data[type=isosurface].colorbar.title.font
Type: color - family
Parent:data[type=isosurface].colorbar.title.font
Type: stringHTML 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.
- lineposition
Parent:data[type=isosurface].colorbar.title.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=isosurface].colorbar.title.font
Type: string
Default:"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.
- size
Parent:data[type=isosurface].colorbar.title.font
Type: number greater than or equal to 1 - style
Parent:data[type=isosurface].colorbar.title.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=isosurface].colorbar.title.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=isosurface].colorbar.title.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=isosurface].colorbar.title.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- side
Parent:data[type=isosurface].colorbar.title
Type: enumerated , one of ("right"|"top"|"bottom")Determines the location of color bar's title with respect to the color bar. Defaults to "top" when `orientation` if "v" and defaults to "right" when `orientation` if "h".
- text
Parent:data[type=isosurface].colorbar.title
Type: stringSets the title of the color bar.
- font
- x
Parent:data[type=isosurface].colorbar
Type: numberSets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is "paper", defaults to 1.02 when `orientation` is "v" and 0.5 when `orientation` is "h". When `xref` is "container", defaults to "1" when `orientation` is "v" and 0.5 when `orientation` is "h". Must be between "0" and "1" if `xref` is "container" and between "-2" and "3" if `xref` is "paper".
- xanchor
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("left"|"center"|"right")Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar. Defaults to "left" when `orientation` is "v" and "center" when `orientation` is "h".
- xpad
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the x direction.
- xref
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
- y
Parent:data[type=isosurface].colorbar
Type: numberSets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is "paper", defaults to 0.5 when `orientation` is "v" and 1.02 when `orientation` is "h". When `yref` is "container", defaults to 0.5 when `orientation` is "v" and 1 when `orientation` is "h". Must be between "0" and "1" if `yref` is "container" and between "-2" and "3" if `yref` is "paper".
- yanchor
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("top"|"middle"|"bottom")Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar. Defaults to "middle" when `orientation` is "v" and "bottom" when `orientation` is "h".
- ypad
Parent:data[type=isosurface].colorbar
Type: number greater than or equal to 0
Default:10Sets the amount of padding (in px) along the y direction.
- yref
Parent:data[type=isosurface].colorbar
Type: enumerated , one of ("container"|"paper")
Default:"paper"Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
- bgcolor
- autocolorscale
Parent:data[type=isosurface]
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- colorscale
Parent:data[type=isosurface]
Type: colorscaleSets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- showscale
Parent:data[type=isosurface]
Type: boolean
Default:trueDetermines whether or not a colorbar is displayed for this trace.
- reversescale
Parent:data[type=isosurface]
Type: booleanReverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
- zhoverformat
Parent:data[type=isosurface]
Type: string
Default:""Sets the hover text formatting rulefor `z` 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"By default the values are formatted using `zaxis.hoverformat`.
- cauto
Parent:data[type=isosurface]
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.
- cmax
Parent:data[type=isosurface]
Type: numberSets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.
- cmid
Parent:data[type=isosurface]
Type: numberSets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.
- cmin
Parent:data[type=isosurface]
Type: numberSets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.
- caps
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=isosurface].caps
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].caps.x
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=isosurface].caps.x
Type: boolean
Default:trueSets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- fill
- y
Parent:data[type=isosurface].caps
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].caps.y
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=isosurface].caps.y
Type: boolean
Default:trueSets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- fill
- z
Parent:data[type=isosurface].caps
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].caps.z
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- show
Parent:data[type=isosurface].caps.z
Type: boolean
Default:trueSets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- fill
- x
- contour
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- color
Parent:data[type=isosurface].contour
Type: color
Default:"#444"Sets the color of the contour lines.
- show
Parent:data[type=isosurface].contour
Type: booleanSets whether or not dynamic contours are shown on hover
- width
Parent:data[type=isosurface].contour
Type: number between or equal to 1 and 16
Default:2Sets the width of the contour lines.
- color
- flatshading
Parent:data[type=isosurface]
Type: boolean
Default:trueDetermines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
- hoverlabel
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- align
Parent:data[type=isosurface].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"|"right"|"auto")
Default:"auto"Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
- bgcolor
Parent:data[type=isosurface].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=isosurface].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=isosurface].hoverlabel
Type: object containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=isosurface].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=isosurface].hoverlabel.font
Type: string or array of stringsHTML 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.
- lineposition
Parent:data[type=isosurface].hoverlabel.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=isosurface].hoverlabel.font
Type: string or array of strings
Default:"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.
- size
Parent:data[type=isosurface].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=isosurface].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=isosurface].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=isosurface].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=isosurface].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=isosurface].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
- showarrow
Parent:data[type=isosurface].hoverlabel
Type: boolean
Default:trueSets whether or not to show the hover label arrow/triangle pointing to the data point.
- align
- isomax
Parent:data[type=isosurface]
Type: numberSets the maximum boundary for iso-surface plot.
- isomin
Parent:data[type=isosurface]
Type: numberSets the minimum boundary for iso-surface plot.
- lighting
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- ambient
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 1
Default:0.8Ambient light increases overall color visibility but can wash out the image.
- diffuse
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 1
Default:0.8Represents the extent that incident rays are reflected in a range of angles.
- facenormalsepsilon
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 1
Default:0Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- fresnel
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 5
Default:0.2Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
- roughness
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 1
Default:0.5Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- specular
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 2
Default:0.05Represents the level that incident rays are reflected in a single direction, causing shine.
- vertexnormalsepsilon
Parent:data[type=isosurface].lighting
Type: number between or equal to 0 and 1
Default:1e-12Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
- ambient
- lightposition
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=isosurface].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the X coordinate for each vertex.
- y
Parent:data[type=isosurface].lightposition
Type: number between or equal to -100000 and 100000
Default:100000Numeric vector, representing the Y coordinate for each vertex.
- z
Parent:data[type=isosurface].lightposition
Type: number between or equal to -100000 and 100000
Default:0Numeric vector, representing the Z coordinate for each vertex.
- x
- slices
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- x
Parent:data[type=isosurface].slices
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].slices.x
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- locations
Parent:data[type=isosurface].slices.x
Type: data array
Default:Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
- show
Parent:data[type=isosurface].slices.x
Type: booleanDetermines whether or not slice planes about the x dimension are drawn.
- fill
- y
Parent:data[type=isosurface].slices
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].slices.y
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- locations
Parent:data[type=isosurface].slices.y
Type: data array
Default:Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
- show
Parent:data[type=isosurface].slices.y
Type: booleanDetermines whether or not slice planes about the y dimension are drawn.
- fill
- z
Parent:data[type=isosurface].slices
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].slices.z
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- locations
Parent:data[type=isosurface].slices.z
Type: data array
Default:Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
- show
Parent:data[type=isosurface].slices.z
Type: booleanDetermines whether or not slice planes about the z dimension are drawn.
- fill
- x
- spaceframe
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- fill
Parent:data[type=isosurface].spaceframe
Type: number between or equal to 0 and 1
Default:0.15Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater `fill` ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).
- show
Parent:data[type=isosurface].spaceframe
Type: booleanDisplays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
- fill
- surface
Parent:data[type=isosurface]
Type: object containing one or more of the keys listed below.- count
Parent:data[type=isosurface].surface
Type: integer greater than or equal to 1
Default:2Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
- fill
Parent:data[type=isosurface].surface
Type: number between or equal to 0 and 1
Default:1Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
- pattern
Parent:data[type=isosurface].surface
Type: flaglist string. Any combination of"A","B","C","D","E"joined with a"+"OR"all"or"odd"or"even".
Examples:"A","B","A+B","A+B+C","all"
Default:"all"Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
- show
Parent:data[type=isosurface].surface
Type: boolean
Default:trueHides/displays surfaces between minimum and maximum iso-values.
- count
- uirevision
Parent:data[type=isosurface]
Type: number or categorical coordinate stringControls 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.
scattergeo traces
scattergeo trace is an object with the key "type" equal to "scattergeo" (i.e. {"type": "scattergeo"}) and any of the keys listed below. The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`.
- type
Parent:data[type=scattergeo]
Type: "scattergeo" - name
Parent:data[type=scattergeo]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=scattergeo]
Type: enumerated , one of (true|false|"legendonly")
Default:trueDetermines 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).
- showlegend
Parent:data[type=scattergeo]
Type: boolean
Default:trueDetermines whether or not an item corresponding to this trace is shown in the legend.
- legend
Parent:data[type=scattergeo]
Type: subplotid
Default:legendSets 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.
- legendrank
Parent:data[type=scattergeo]
Type: number
Default:1000Sets 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.
- legendgroup
Parent:data[type=scattergeo]
Type: string
Default:""Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
- legendgrouptitle
Parent:data[type=scattergeo]
Type: object containing one or more of the keys listed below.- font
Parent:data[type=scattergeo].legendgrouptitle
Type: object containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=scattergeo].legendgrouptitle.font
Type: color - family
Parent:data[type=scattergeo].legendgrouptitle.font
Type: stringHTML 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.
- lineposition
Parent:data[type=scattergeo].legendgrouptitle.font
Type: flaglist string. Any combination of"under","over","through"joined with a"+"OR"none".
Examples:"under","over","under+over","under+over+through","none"
Default:"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.
- shadow
Parent:data[type=scattergeo].legendgrouptitle.font
Type: string
Default:"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.
- size
Parent:data[type=scattergeo].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=scattergeo].legendgrouptitle.font
Type: enumerated , one of ("normal"|"italic")
Default:"normal"Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=scattergeo].legendgrouptitle.font
Type: enumerated , one of ("normal"|"word caps"|"upper"|"lower")
Default:"normal"Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=scattergeo].legendgrouptitle.font
Type: enumerated , one of ("normal"|"small-caps"|"all-small-caps"|"all-petite-caps"|"petite-caps"|"unicase")
Default:"normal"Sets the variant of the font.
- weight
Parent:data[type=scattergeo].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normalSets the weight (or boldness) of the font.
- color
- text
Parent:data[type=scattergeo].legendgrouptitle
Type: string
Default:""Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=scattergeo]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- opacity
Parent:data[type=scattergeo]
Type: number between or equal to 0 and 1
Default:1Sets the opacity of the trace.
- mode
Parent:data[type=scattergeo]
Type: flaglist string. Any combination of"lines","markers","text"joined with a"+"OR"none".
Examples:"lines","markers","lines+markers","lines+markers+text","none"
Default:"markers"Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
- ids
Parent:data[type=scattergeo]
Type: data arrayAssigns 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.
- lat
Parent:data[type=scattergeo]
Type: data arraySets the latitude coordinates (in degrees North).
- geojson
Parent:data[type=scattergeo]
Type: number or categorical coordinate stringSets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon".
- featureidkey
Parent:data[type=scattergeo]
Type: string
Default:"id"Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name".
- locations
Parent:data[type=scattergeo]
Type: data arraySets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
- lon
Parent:data[type=scattergeo]
Type: data arraySets the longitude coordinates (in degrees East).
- text
Parent:data[type=scattergeo]
Type: string or array of strings
Default:""Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
- textposition
Parent:data[type=scattergeo]
Type: enumerated or array of enumerateds , one of ("top left"|"top center"|"top right"|"middle left"|"middle center"|"middle right"|"bottom left"|"bottom center"|"bottom right")
Default:"middle center"Sets the positions of the `text` elements with respects to the (x,y) coordinates.
- texttemplate
Parent:data[type=scattergeo]
Type: string or array of strings
Default:""Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `lat`, `lon`, `location` and `text`.
- texttemplatefallback
Parent:data[type=scattergeo]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- hovertext
Parent:data[type=scattergeo]
Type: string or array of strings
Default:""Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
- hoverinfo
Parent:data[type=scattergeo]
Type: flaglist string. Any combination of"lon","lat","location","text","name"joined with a"+"OR"all"or"none"or"skip".
Examples:"lon","lat","lon+lat","lon+lat+location","all"
Default:"all"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
- hovertemplate
Parent:data[type=scattergeo]
Type: string or array of strings
Default:""Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.
- hovertemplatefallback
Parent:data[type=scattergeo]
Type: number or categorical coordinate string
Default:-Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
- meta
Parent:data[type=scattergeo]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=scattergeo]
Type: data arrayAssigns 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
- geo
Parent:data[type=scattergeo]
Type: subplotid
Default:geoSets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on.
- marker
Parent:data[type=scattergeo]
Type: object containing one or more of the keys listed below.- angle
Parent:data[type=scattergeo].marker
Type: angle
Default:0Sets the marker angle in respect to `angleref`.
- angleref
Parent:data[type=scattergeo].marker
Type: enumerated , one of ("previous"|"up"|"north")
Default:"up"Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen. With "north", angle 0 points north based on the current map projection.
- autocolorscale
Parent:data[type=scattergeo].marker
Type: boolean
Default:trueDetermines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
- cauto
Parent:data[type=scattergeo].marker
Type: boolean
Default:trueDetermines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
- cmax
Parent:data[type=scattergeo].marker
Type: numberSets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
- cmid
Parent:data[type=scattergeo].marker
Type: numberSets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
- cmin
Parent:data[type=scattergeo].marker
Type: numberSets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
- color
Parent:data[type=scattergeo].marker
Type: color or array of colorsSets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
- coloraxis
Parent:data[type=scattergeo].marker
Type: subplotidSets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
- colorbar
Parent:data[type=scattergeo].marker
Type: object containing one or more of the keys listed below.- bgcolor
Parent:data[type=scattergeo].marker.colorbar
Type: color
Default:"rgba(0,0,0,0)"Sets the color of padded area.
- bordercolor
Parent:data[type=scattergeo].marker.colorbar
Type: color
Default:"#444"Sets the axis line color.
- borderwidth
Parent:data[type=scattergeo].marker.colorbar
Type: number greater than or equal to 0
Default:0Sets the width (in px) or the border enclosing this color bar.
- dtick
Parent:data[type=scattergeo].marker.colorbar
Type: number or categorical coordinate stringSets 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 igno
- bgcolor
- angle