Plotly.js Reference

0. Layout

angularaxis
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this angular axis.

domain
Parent:
layout.angularaxis
Type:
array
Default:
[0, 1]

Polar chart subplots are not supported yet. This key has currently no effect.

endpadding
Parent:
layout.angularaxis
Type:
number

Legacy polar charts are deprecated! Please switch to "polar" subplots.

range
Parent:
layout.angularaxis
Type:
array

Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this angular axis.

showline
Parent:
layout.angularaxis
Type:
boolean

Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the line bounding this angular axis will be shown on the figure.

showticklabels
Parent:
layout.angularaxis
Type:
boolean

Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the angular axis ticks will feature tick labels.

tickcolor
Parent:
layout.angularaxis
Type:
color

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the color of the tick lines on this angular axis.

ticklen
Parent:
layout.angularaxis
Type:
number greater than or equal to 0

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this angular axis.

tickorientation
Parent:
layout.angularaxis
Type:
enumerated , one of ( "horizontal" | "vertical" )

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (from the paper perspective) of the angular axis tick labels.

ticksuffix
Parent:
layout.angularaxis
Type:
string

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this angular axis.

visible
Parent:
layout.angularaxis
Type:
boolean

Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not this axis will be visible.

annotations
Parent:
layout
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this annotation is visible.

align
Parent:
layout.annotations[]
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"center"

Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans more 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.

arrowcolor
Parent:
layout.annotations[]
Type:
color

Sets the color of the annotation arrow.

arrowhead
Parent:
layout.annotations[]
Type:
integer between or equal to 0 and 8
Default:
1

Sets the end annotation arrow head style.

arrowside
Parent:
layout.annotations[]
Type:
flaglist string. Any combination of "end", "start" joined with a "+" OR "none".
Default:
"end"

Sets the annotation arrow head position.

arrowsize
Parent:
layout.annotations[]
Type:
number greater than or equal to 0.3
Default:
1

Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.

arrowwidth
Parent:
layout.annotations[]
Type:
number greater than or equal to 0.1

Sets the width (in px) of annotation arrow line.

ax
Parent:
layout.annotations[]
Type:
number or categorical coordinate string

Sets the x component of the arrow tail about the arrow head. If `axref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If `axref` is an axis, this is an absolute value on that axis, like `x`, NOT a relative value.

axref
Parent:
layout.annotations[]
Type:
enumerated , one of ( "pixel" | "/^x([2-9]|[1-9][0-9]+)?$/" )
Default:
"pixel"

Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ax` is a relative offset in pixels from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed.

ay
Parent:
layout.annotations[]
Type:
number or categorical coordinate string

Sets the y component of the arrow tail about the arrow head. If `ayref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If `ayref` is an axis, this is an absolute value on that axis, like `y`, NOT a relative value.

ayref
Parent:
layout.annotations[]
Type:
enumerated , one of ( "pixel" | "/^y([2-9]|[1-9][0-9]+)?$/" )
Default:
"pixel"

Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ay` is a relative offset in pixels from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed.

bgcolor
Parent:
layout.annotations[]
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the background color of the annotation.

bordercolor
Parent:
layout.annotations[]
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of the border enclosing the annotation `text`.

borderpad
Parent:
layout.annotations[]
Type:
number greater than or equal to 0
Default:
1

Sets the padding (in px) between the `text` and the enclosing border.

borderwidth
Parent:
layout.annotations[]
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the border enclosing the annotation `text`.

captureevents
Parent:
layout.annotations[]
Type:
boolean

Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is "false" unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`.

clicktoshow
Parent:
layout.annotations[]
Type:
enumerated , one of ( false | "onoff" | "onout" )

Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the `x` and `y` values of this annotation, and it is hidden (visible: false), it will appear. In "onoff" mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In "onout" mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different `x` or `y` values, you can set `xclick` and/or `yclick`. This is useful for example to label the side of a bar. To label markers though, `standoff` is preferred over `xclick` and `yclick`.

font
Parent:
layout.annotations[]
Type:
object containing one or more of the keys listed below.

Sets the annotation text font.

color
Parent:
layout.annotations[].font
Type:
color
family
Parent:
layout.annotations[].font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.annotations[].font
Type:
number greater than or equal to 1
height
Parent:
layout.annotations[]
Type:
number greater than or equal to 1

Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.

hoverlabel
Parent:
layout.annotations[]
Type:
object containing one or more of the keys listed below.

Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.

bgcolor
Parent:
layout.annotations[].hoverlabel
Type:
color

Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.

bordercolor
Parent:
layout.annotations[].hoverlabel
Type:
color

Sets the border color of the hover label. By default uses either dark grey or white, for maximum contrast with `hoverlabel.bgcolor`.

font
Parent:
layout.annotations[].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the hover label text font. By default uses the global hover font and size, with color from `hoverlabel.bordercolor`.

color
Parent:
layout.annotations[].hoverlabel.font
Type:
color
family
Parent:
layout.annotations[].hoverlabel.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.annotations[].hoverlabel.font
Type:
number greater than or equal to 1
hovertext
Parent:
layout.annotations[]
Type:
string

Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.

name
Parent:
layout.annotations[]
Type:
string

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

opacity
Parent:
layout.annotations[]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the annotation (text + arrow).

showarrow
Parent:
layout.annotations[]
Type:
boolean
Default:
true

Determines whether or not the annotation is drawn with an arrow. If "true", `text` is placed near the arrow's tail. If "false", `text` lines up with the `x` and `y` provided.

standoff
Parent:
layout.annotations[]
Type:
number greater than or equal to 0
Default:
0

Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.

startarrowhead
Parent:
layout.annotations[]
Type:
integer between or equal to 0 and 8
Default:
1

Sets the start annotation arrow head style.

startarrowsize
Parent:
layout.annotations[]
Type:
number greater than or equal to 0.3
Default:
1

Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.

startstandoff
Parent:
layout.annotations[]
Type:
number greater than or equal to 0
Default:
0

Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.

templateitemname
Parent:
layout.annotations[]
Type:
string

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

text
Parent:
layout.annotations[]
Type:
string

Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.

textangle
Parent:
layout.annotations[]
Type:
angle
Default:
0

Sets the angle at which the `text` is drawn with respect to the horizontal.

valign
Parent:
layout.annotations[]
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height.

visible
Parent:
layout.annotations[]
Type:
boolean
Default:
true

Determines whether or not this annotation is visible.

width
Parent:
layout.annotations[]
Type:
number greater than or equal to 1

Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.

x
Parent:
layout.annotations[]
Type:
number or categorical coordinate string

Sets the annotation's x position. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

xanchor
Parent:
layout.annotations[]
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"auto"

Sets the text box's horizontal position anchor This anchor binds the `x` position to the "left", "center" or "right" of the annotation. For example, if `x` is set to 1, `xref` to "paper" and `xanchor` to "right" then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If "auto", the anchor is equivalent to "center" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

xclick
Parent:
layout.annotations[]
Type:
number or categorical coordinate string

Toggle this annotation when clicking a data point whose `x` value is `xclick` rather than the annotation's `x` value.

xref
Parent:
layout.annotations[]
Type:
enumerated , one of ( "paper" | "/^x([2-9]|[1-9][0-9]+)?$/" )

Sets the annotation's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side.

xshift
Parent:
layout.annotations[]
Type:
number
Default:
0

Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.

y
Parent:
layout.annotations[]
Type:
number or categorical coordinate string

Sets the annotation's y position. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

yanchor
Parent:
layout.annotations[]
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
Default:
"auto"

Sets the text box's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the annotation. For example, if `y` is set to 1, `yref` to "paper" and `yanchor` to "top" then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If "auto", the anchor is equivalent to "middle" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

yclick
Parent:
layout.annotations[]
Type:
number or categorical coordinate string

Toggle this annotation when clicking a data point whose `y` value is `yclick` rather than the annotation's `y` value.

yref
Parent:
layout.annotations[]
Type:
enumerated , one of ( "paper" | "/^y([2-9]|[1-9][0-9]+)?$/" )

Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top).

yshift
Parent:
layout.annotations[]
Type:
number
Default:
0

Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.

autosize
Parent:
layout
Type:
boolean

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

calendar
Parent:
layout
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

clickmode
Parent:
layout
Type:
flaglist string. Any combination of "event", "select" joined with a "+" OR "none".
Default:
"event"

Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.

coloraxis
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
true

Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

autocolorscale
Parent:
layout.coloraxis
Type:
boolean
Default:
true

Determines 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.

cauto
Parent:
layout.coloraxis
Type:
boolean
Default:
true

Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.

cmax
Parent:
layout.coloraxis
Type:
number

Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmin` must be set as well.

cmid
Parent:
layout.coloraxis
Type:
number

Sets 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 corresponding trace color array(s). Has no effect when `cauto` is `false`.

cmin
Parent:
layout.coloraxis
Type:
number

Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well.

colorbar
Parent:
layout.coloraxis
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
layout.coloraxis.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
layout.coloraxis.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
layout.coloraxis.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.coloraxis.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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:
layout.coloraxis.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.

nticks
Parent:
layout.coloraxis.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
layout.coloraxis.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
layout.coloraxis.colorbar
Type:
boolean

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

showexponent
Parent:
layout.coloraxis.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:
layout.coloraxis.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.coloraxis.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:
layout.coloraxis.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
layout.coloraxis.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:
layout.coloraxis.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.coloraxis.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:
layout.coloraxis.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.coloraxis.colorbar
Type:
object containing one or more of the keys listed below.

Sets the color bar's tick label font

color
Parent:
layout.coloraxis.colorbar.tickfont
Type:
color
family
Parent:
layout.coloraxis.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.coloraxis.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.coloraxis.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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.coloraxis.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.coloraxis.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.coloraxis.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.coloraxis.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.coloraxis.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
layout.coloraxis.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.coloraxis.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:
layout.coloraxis.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.coloraxis.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:
layout.coloraxis.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.coloraxis.colorbar
Type:
data array

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

tickvals
Parent:
layout.coloraxis.colorbar
Type:
data array

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

tickwidth
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.coloraxis.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.coloraxis.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
layout.coloraxis.colorbar.title.font
Type:
color
family
Parent:
layout.coloraxis.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.coloraxis.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
layout.coloraxis.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
layout.coloraxis.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
layout.coloraxis.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
layout.coloraxis.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
layout.coloraxis.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
layout.coloraxis.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
layout.coloraxis.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
layout.coloraxis
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
layout.coloraxis
Type:
boolean

Reverses 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.

showscale
Parent:
layout.coloraxis
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

colorscale
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[[0, rgb(220,220,220)], [0.2, rgb(245,195,157)], [0.4, rgb(245,160,105)], [1, rgb(178,10,28)], ]

Sets the default sequential colorscale for positive values. Note that `autocolorscale` must be true for this attribute to work.

diverging
Parent:
layout.colorscale
Type:
colorscale
Default:
[[0, rgb(5,10,172)], [0.35, rgb(106,137,247)], [0.5, rgb(190,190,190)], [0.6, rgb(220,170,132)], [0.7, rgb(230,145,90)], [1, rgb(178,10,28)], ]

Sets the default diverging colorscale. Note that `autocolorscale` must be true for this attribute to work.

sequential
Parent:
layout.colorscale
Type:
colorscale
Default:
[[0, rgb(220,220,220)], [0.2, rgb(245,195,157)], [0.4, rgb(245,160,105)], [1, rgb(178,10,28)], ]

Sets the default sequential colorscale for positive values. Note that `autocolorscale` must be true for this attribute to work.

sequentialminus
Parent:
layout.colorscale
Type:
colorscale
Default:
[[0, rgb(5,10,172)], [0.35, rgb(40,60,190)], [0.5, rgb(70,100,245)], [0.6, rgb(90,120,245)], [0.7, rgb(106,137,247)], [1, rgb(220,220,220)], ]

Sets the default sequential colorscale for negative values. Note that `autocolorscale` must be true for this attribute to work.

colorway
Parent:
layout
Type:
colorlist
Default:
[#1f77b4, #ff7f0e, #2ca02c, #d62728, #9467bd, #8c564b, #e377c2, #7f7f7f, #bcbd22, #17becf]

Sets the default trace colors.

datarevision
Parent:
layout
Type:
number or categorical coordinate string

If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

direction
Parent:
layout
Type:
enumerated , one of ( "clockwise" | "counterclockwise" )

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the direction corresponding to positive angles in legacy polar charts.

dragmode
Parent:
layout
Type:
enumerated , one of ( "zoom" | "pan" | "select" | "lasso" | "orbit" | "turntable" | false )
Default:
"zoom"

Determines the mode of drag interactions. "select" and "lasso" apply only to scatter traces with markers or text. "orbit" and "turntable" apply only to 3D scenes.

editrevision
Parent:
layout
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.

font
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
""Open Sans", verdana, arial, sans-serif"

Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

color
Parent:
layout.font
Type:
color
Default:
"#444"
family
Parent:
layout.font
Type:
string
Default:
""Open Sans", verdana, arial, sans-serif"

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.font
Type:
number greater than or equal to 1
Default:
12
geo
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.

bgcolor
Parent:
layout.geo
Type:
color
Default:
"#fff"

Set the background color of the map

center
Parent:
layout.geo
Type:
object containing one or more of the keys listed below.

Sets the longitude of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above `projection.rotation.lon` otherwise.

lat
Parent:
layout.geo.center
Type:
number

Sets the latitude of the map's center. For all projection types, the map's latitude center lies at the middle of the latitude range by default.

lon
Parent:
layout.geo.center
Type:
number

Sets the longitude of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above `projection.rotation.lon` otherwise.

coastlinecolor
Parent:
layout.geo
Type:
color
Default:
"#444"

Sets the coastline color.

coastlinewidth
Parent:
layout.geo
Type:
number greater than or equal to 0
Default:
1

Sets the coastline stroke width (in px).

countrycolor
Parent:
layout.geo
Type:
color
Default:
"#444"

Sets line color of the country boundaries.

countrywidth
Parent:
layout.geo
Type:
number greater than or equal to 0
Default:
1

Sets line width (in px) of the country boundaries.

domain
Parent:
layout.geo
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.

column
Parent:
layout.geo.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.

row
Parent:
layout.geo.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.

x
Parent:
layout.geo.domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.

y
Parent:
layout.geo.domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.

framecolor
Parent:
layout.geo
Type:
color
Default:
"#444"

Sets the color the frame.

framewidth
Parent:
layout.geo
Type:
number greater than or equal to 0
Default:
1

Sets the stroke width (in px) of the frame.

lakecolor
Parent:
layout.geo
Type:
color
Default:
"#3399FF"

Sets the color of the lakes.

landcolor
Parent:
layout.geo
Type:
color
Default:
"#F0DC82"

Sets the land mass color.

lataxis
Parent:
layout.geo
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the range of this axis (in degrees), sets the map's clipped coordinates.

dtick
Parent:
layout.geo.lataxis
Type:
number

Sets the graticule's longitude/latitude tick step.

gridcolor
Parent:
layout.geo.lataxis
Type:
color
Default:
"#eee"

Sets the graticule's stroke color.

gridwidth
Parent:
layout.geo.lataxis
Type:
number greater than or equal to 0
Default:
1

Sets the graticule's stroke width (in px).

range
Parent:
layout.geo.lataxis
Type:
array

Sets the range of this axis (in degrees), sets the map's clipped coordinates.

showgrid
Parent:
layout.geo.lataxis
Type:
boolean

Sets whether or not graticule are shown on the map.

tick0
Parent:
layout.geo.lataxis
Type:
number
Default:
0

Sets the graticule's starting tick longitude/latitude.

lonaxis
Parent:
layout.geo
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the range of this axis (in degrees), sets the map's clipped coordinates.

dtick
Parent:
layout.geo.lonaxis
Type:
number

Sets the graticule's longitude/latitude tick step.

gridcolor
Parent:
layout.geo.lonaxis
Type:
color
Default:
"#eee"

Sets the graticule's stroke color.

gridwidth
Parent:
layout.geo.lonaxis
Type:
number greater than or equal to 0
Default:
1

Sets the graticule's stroke width (in px).

range
Parent:
layout.geo.lonaxis
Type:
array

Sets the range of this axis (in degrees), sets the map's clipped coordinates.

showgrid
Parent:
layout.geo.lonaxis
Type:
boolean

Sets whether or not graticule are shown on the map.

tick0
Parent:
layout.geo.lonaxis
Type:
number
Default:
0

Sets the graticule's starting tick longitude/latitude.

oceancolor
Parent:
layout.geo
Type:
color
Default:
"#3399FF"

Sets the ocean color

projection
Parent:
layout.geo
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the projection type.

parallels
Parent:
layout.geo.projection
Type:
array

For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.

rotation
Parent:
layout.geo.projection
Type:
object containing one or more of the keys listed below.

Rotates the map along parallels (in degrees East). Defaults to the center of the `lonaxis.range` values.

lat
Parent:
layout.geo.projection.rotation
Type:
number

Rotates the map along meridians (in degrees North).

lon
Parent:
layout.geo.projection.rotation
Type:
number

Rotates the map along parallels (in degrees East). Defaults to the center of the `lonaxis.range` values.

roll
Parent:
layout.geo.projection.rotation
Type:
number

Roll the map (in degrees) For example, a roll of "180" makes the map appear upside down.

scale
Parent:
layout.geo.projection
Type:
number greater than or equal to 0
Default:
1

Zooms in or out on the map view. A scale of "1" corresponds to the largest zoom level that fits the map's lon and lat ranges.

type
Parent:
layout.geo.projection
Type:
enumerated , one of ( "equirectangular" | "mercator" | "orthographic" | "natural earth" | "kavrayskiy7" | "miller" | "robinson" | "eckert4" | "azimuthal equal area" | "azimuthal equidistant" | "conic equal area" | "conic conformal" | "conic equidistant" | "gnomonic" | "stereographic" | "mollweide" | "hammer" | "transverse mercator" | "albers usa" | "winkel tripel" | "aitoff" | "sinusoidal" )

Sets the projection type.

resolution
Parent:
layout.geo
Type:
enumerated , one of ( "110" | "50" )
Default:
"110"

Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

rivercolor
Parent:
layout.geo
Type:
color
Default:
"#3399FF"

Sets color of the rivers.

riverwidth
Parent:
layout.geo
Type:
number greater than or equal to 0
Default:
1

Sets the stroke width (in px) of the rivers.

scope
Parent:
layout.geo
Type:
enumerated , one of ( "world" | "usa" | "europe" | "asia" | "africa" | "north america" | "south america" )
Default:
"world"

Set the scope of the map.

showcoastlines
Parent:
layout.geo
Type:
boolean

Sets whether or not the coastlines are drawn.

showcountries
Parent:
layout.geo
Type:
boolean

Sets whether or not country boundaries are drawn.

showframe
Parent:
layout.geo
Type:
boolean

Sets whether or not a frame is drawn around the map.

showlakes
Parent:
layout.geo
Type:
boolean

Sets whether or not lakes are drawn.

showland
Parent:
layout.geo
Type:
boolean

Sets whether or not land masses are filled in color.

showocean
Parent:
layout.geo
Type:
boolean

Sets whether or not oceans are filled in color.

showrivers
Parent:
layout.geo
Type:
boolean

Sets whether or not rivers are drawn.

showsubunits
Parent:
layout.geo
Type:
boolean

Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.

subunitcolor
Parent:
layout.geo
Type:
color
Default:
"#444"

Sets the color of the subunits boundaries.

subunitwidth
Parent:
layout.geo
Type:
number greater than or equal to 0
Default:
1

Sets the stroke width (in px) of the subunits boundaries.

uirevision
Parent:
layout.geo
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in the view (projection and center). Defaults to `layout.uirevision`.

grid
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"top to bottom"

The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

columns
Parent:
layout.grid
Type:
integer greater than or equal to 1

The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used as the default. If you give an `xaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

domain
Parent:
layout.grid
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.

x
Parent:
layout.grid.domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.

y
Parent:
layout.grid.domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.

pattern
Parent:
layout.grid
Type:
enumerated , one of ( "independent" | "coupled" )
Default:
"coupled"

If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`.

roworder
Parent:
layout.grid
Type:
enumerated , one of ( "top to bottom" | "bottom to top" )
Default:
"top to bottom"

Is the first row the top or the bottom? Note that columns are always enumerated from left to right.

rows
Parent:
layout.grid
Type:
integer greater than or equal to 1

The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

subplots
Parent:
layout.grid
Type:
array

Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.

xaxes
Parent:
layout.grid
Type:
array

Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.

xgap
Parent:
layout.grid
Type:
number between or equal to 0 and 1

Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.

xside
Parent:
layout.grid
Type:
enumerated , one of ( "bottom" | "bottom plot" | "top plot" | "top" )
Default:
"bottom plot"

Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar.

yaxes
Parent:
layout.grid
Type:
array

Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.

ygap
Parent:
layout.grid
Type:
number between or equal to 0 and 1

Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.

yside
Parent:
layout.grid
Type:
enumerated , one of ( "left" | "left plot" | "right plot" | "right" )
Default:
"left plot"

Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.

height
Parent:
layout
Type:
number greater than or equal to 10
Default:
450

Sets the plot's height (in px).

hidesources
Parent:
layout
Type:
boolean

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the plotly service (at https://plot.ly or on-premise).

hoverdistance
Parent:
layout
Type:
integer greater than or equal to -1
Default:
20

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.

hoverlabel
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"Arial, sans-serif"

Sets the background color of all hover labels on graph

align
Parent:
layout.hoverlabel
Type:
enumerated , 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:
layout.hoverlabel
Type:
color

Sets the background color of all hover labels on graph

bordercolor
Parent:
layout.hoverlabel
Type:
color

Sets the border color of all hover labels on graph.

font
Parent:
layout.hoverlabel
Type:
object containing one or more of the keys listed below.
Default:
"Arial, sans-serif"

Sets the default hover label font used by all traces on the graph.

color
Parent:
layout.hoverlabel.font
Type:
color
family
Parent:
layout.hoverlabel.font
Type:
string
Default:
"Arial, sans-serif"

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.hoverlabel.font
Type:
number greater than or equal to 1
Default:
13
namelength
Parent:
layout.hoverlabel
Type:
integer greater than or equal to -1
Default:
15

Sets 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.

hovermode
Parent:
layout
Type:
enumerated , one of ( "x" | "y" | "closest" | false )

Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` defaults to "closest". If `clickmode` lacks the "select" flag, it defaults to "x" or "y" (depending on the trace's `orientation` value) for plots based on cartesian coordinates. For anything else the default value is "closest".

images
Parent:
layout
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this image is visible.

layer
Parent:
layout.images[]
Type:
enumerated , one of ( "below" | "above" )
Default:
"above"

Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, image is drawn below the entire plot area.

name
Parent:
layout.images[]
Type:
string

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

opacity
Parent:
layout.images[]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the image.

sizex
Parent:
layout.images[]
Type:
number
Default:
0

Sets the image container size horizontally. The image will be sized based on the `position` value. When `xref` is set to `paper`, units are sized relative to the plot width.

sizey
Parent:
layout.images[]
Type:
number
Default:
0

Sets the image container size vertically. The image will be sized based on the `position` value. When `yref` is set to `paper`, units are sized relative to the plot height.

sizing
Parent:
layout.images[]
Type:
enumerated , one of ( "fill" | "contain" | "stretch" )
Default:
"contain"

Specifies which dimension of the image to constrain.

source
Parent:
layout.images[]
Type:
string

Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute.

templateitemname
Parent:
layout.images[]
Type:
string

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

visible
Parent:
layout.images[]
Type:
boolean
Default:
true

Determines whether or not this image is visible.

x
Parent:
layout.images[]
Type:
number or categorical coordinate string
Default:
0

Sets the image's x position. When `xref` is set to `paper`, units are sized relative to the plot height. See `xref` for more info

xanchor
Parent:
layout.images[]
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets the anchor for the x position

xref
Parent:
layout.images[]
Type:
enumerated , one of ( "paper" | "/^x([2-9]|[1-9][0-9]+)?$/" )
Default:
"paper"

Sets the images's x coordinate axis. If set to a x axis id (e.g. "x" or "x2"), the `x` position refers to an x data coordinate If set to "paper", the `x` position refers to the distance from the left of plot in normalized coordinates where "0" ("1") corresponds to the left (right).

y
Parent:
layout.images[]
Type:
number or categorical coordinate string
Default:
0

Sets the image's y position. When `yref` is set to `paper`, units are sized relative to the plot height. See `yref` for more info

yanchor
Parent:
layout.images[]
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"top"

Sets the anchor for the y position.

yref
Parent:
layout.images[]
Type:
enumerated , one of ( "paper" | "/^y([2-9]|[1-9][0-9]+)?$/" )
Default:
"paper"

Sets the images's y coordinate axis. If set to a y axis id (e.g. "y" or "y2"), the `y` position refers to a y data coordinate. If set to "paper", the `y` position refers to the distance from the bottom of the plot in normalized coordinates where "0" ("1") corresponds to the bottom (top).

legend
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the legend background color.

bgcolor
Parent:
layout.legend
Type:
color

Sets the legend background color.

bordercolor
Parent:
layout.legend
Type:
color
Default:
"#444"

Sets the color of the border enclosing the legend.

borderwidth
Parent:
layout.legend
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) of the border enclosing the legend.

font
Parent:
layout.legend
Type:
object containing one or more of the keys listed below.

Sets the font used to text the legend items.

color
Parent:
layout.legend.font
Type:
color
family
Parent:
layout.legend.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.legend.font
Type:
number greater than or equal to 1
itemclick
Parent:
layout.legend
Type:
enumerated , one of ( "toggle" | "toggleothers" | false )
Default:
"toggle"

Determines the behavior on legend item click. "toggle" toggles the visibility of the item clicked on the graph. "toggleothers" makes the clicked item the sole visible item on the graph. "false" disable legend item click interactions.

itemdoubleclick
Parent:
layout.legend
Type:
enumerated , one of ( "toggle" | "toggleothers" | false )
Default:
"toggleothers"

Determines the behavior on legend item double-click. "toggle" toggles the visibility of the item clicked on the graph. "toggleothers" makes the clicked item the sole visible item on the graph. "false" disable legend item double-click interactions.

itemsizing
Parent:
layout.legend
Type:
enumerated , one of ( "trace" | "constant" )
Default:
"trace"

Determines if the legend items symbols scale with their corresponding "trace" attributes or remain "constant" independent of the symbol size on the graph.

orientation
Parent:
layout.legend
Type:
enumerated , one of ( "v" | "h" )
Default:
"v"

Sets the orientation of the legend.

tracegroupgap
Parent:
layout.legend
Type:
number greater than or equal to 0
Default:
10

Sets the amount of vertical space (in px) between legend groups.

traceorder
Parent:
layout.legend
Type:
flaglist string. Any combination of "reversed", "grouped" joined with a "+" OR "normal".

Determines the order at which the legend items are displayed. If "normal", the items are displayed top-to-bottom in the same order as the input data. If "reversed", the items are displayed in the opposite order as "normal". If "grouped", the items are displayed in groups (when a trace `legendgroup` is provided). if "grouped+reversed", the items are displayed in the opposite order as "grouped".

uirevision
Parent:
layout.legend
Type:
number or categorical coordinate string

Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to `layout.uirevision`.

valign
Parent:
layout.legend
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets the vertical alignment of the symbols with respect to their associated text.

x
Parent:
layout.legend
Type:
number between or equal to -2 and 3

Sets the x position (in normalized coordinates) of the legend. Defaults to "1.02" for vertical legends and defaults to "0" for horizontal legends.

xanchor
Parent:
layout.legend
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"left"

Sets the legend's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the legend. Value "auto" anchors legends to the right for `x` values greater than or equal to 2/3, anchors legends to the left for `x` values less than or equal to 1/3 and anchors legends with respect to their center otherwise.

y
Parent:
layout.legend
Type:
number between or equal to -2 and 3

Sets the y position (in normalized coordinates) of the legend. Defaults to "1" for vertical legends, defaults to "-0.1" for horizontal legends on graphs w/o range sliders and defaults to "1.1" for horizontal legends on graph with one or multiple range sliders.

yanchor
Parent:
layout.legend
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )

Sets the legend's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the legend. Value "auto" anchors legends at their bottom for `y` values less than or equal to 1/3, anchors legends to at their top for `y` values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.

mapbox
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this mapbox subplot (in plot fraction).

accesstoken
Parent:
layout.mapbox
Type:
string

Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under `mapboxAccessToken`. Note that accessToken are only required when `style` (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.

bearing
Parent:
layout.mapbox
Type:
number
Default:
0

Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).

center
Parent:
layout.mapbox
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the longitude of the center of the map (in degrees East).

lat
Parent:
layout.mapbox.center
Type:
number
Default:
0

Sets the latitude of the center of the map (in degrees North).

lon
Parent:
layout.mapbox.center
Type:
number
Default:
0

Sets the longitude of the center of the map (in degrees East).

domain
Parent:
layout.mapbox
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this mapbox subplot (in plot fraction).

column
Parent:
layout.mapbox.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this mapbox subplot .

row
Parent:
layout.mapbox.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this mapbox subplot .

x
Parent:
layout.mapbox.domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this mapbox subplot (in plot fraction).

y
Parent:
layout.mapbox.domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this mapbox subplot (in plot fraction).

layers
Parent:
layout.mapbox
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether this layer is displayed

below
Parent:
layout.mapbox.layers[]
Type:
string

Determines if the layer will be inserted before the layer with the specified ID. If omitted or set to '', the layer will be inserted above every existing layer.

circle
Parent:
layout.mapbox.layers[]
Type:
object containing one or more of the keys listed below.
Default:
15

Sets the circle radius (mapbox.layer.paint.circle-radius). Has an effect only when `type` is set to "circle".

radius
Parent:
layout.mapbox.layers[].circle
Type:
number
Default:
15

Sets the circle radius (mapbox.layer.paint.circle-radius). Has an effect only when `type` is set to "circle".

color
Parent:
layout.mapbox.layers[]
Type:
color
Default:
"#444"

Sets the primary layer color. If `type` is "circle", color corresponds to the circle color (mapbox.layer.paint.circle-color) If `type` is "line", color corresponds to the line color (mapbox.layer.paint.line-color) If `type` is "fill", color corresponds to the fill color (mapbox.layer.paint.fill-color) If `type` is "symbol", color corresponds to the icon color (mapbox.layer.paint.icon-color)

coordinates
Parent:
layout.mapbox.layers[]
Type:
number or categorical coordinate string

Sets the coordinates array contains [longitude, latitude] pairs for the image corners listed in clockwise order: top left, top right, bottom right, bottom left. Only has an effect for "image" `sourcetype`.

fill
Parent:
layout.mapbox.layers[]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the fill outline color (mapbox.layer.paint.fill-outline-color). Has an effect only when `type` is set to "fill".

outlinecolor
Parent:
layout.mapbox.layers[].fill
Type:
color
Default:
"#444"

Sets the fill outline color (mapbox.layer.paint.fill-outline-color). Has an effect only when `type` is set to "fill".

line
Parent:
layout.mapbox.layers[]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line width (mapbox.layer.paint.line-width). Has an effect only when `type` is set to "line".

dash
Parent:
layout.mapbox.layers[].line
Type:
data array

Sets the length of dashes and gaps (mapbox.layer.paint.line-dasharray). Has an effect only when `type` is set to "line".

width
Parent:
layout.mapbox.layers[].line
Type:
number
Default:
2

Sets the line width (mapbox.layer.paint.line-width). Has an effect only when `type` is set to "line".

maxzoom
Parent:
layout.mapbox.layers[]
Type:
number between or equal to 0 and 24
Default:
24

Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minzoom
Parent:
layout.mapbox.layers[]
Type:
number between or equal to 0 and 24
Default:
0

Sets the minimum zoom level (mapbox.layer.minzoom). At zoom levels less than the minzoom, the layer will be hidden.

name
Parent:
layout.mapbox.layers[]
Type:
string

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

opacity
Parent:
layout.mapbox.layers[]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the layer. If `type` is "circle", opacity corresponds to the circle opacity (mapbox.layer.paint.circle-opacity) If `type` is "line", opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity) If `type` is "fill", opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity) If `type` is "symbol", opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity)

source
Parent:
layout.mapbox.layers[]
Type:
number or categorical coordinate string

Sets the source data for this layer (mapbox.layer.source). When `sourcetype` is set to "geojson", `source` can be a URL to a GeoJSON or a GeoJSON object. When `sourcetype` is set to "vector" or "raster", `source` can be a URL or an array of tile URLs. When `sourcetype` is set to "image", `source` can be a URL to an image.

sourceattribution
Parent:
layout.mapbox.layers[]
Type:
string

Sets the attribution for this source.

sourcelayer
Parent:
layout.mapbox.layers[]
Type:
string
Default:
""

Specifies the layer to use from a vector tile source (mapbox.layer.source-layer). Required for "vector" source type that supports multiple layers.

sourcetype
Parent:
layout.mapbox.layers[]
Type:
enumerated , one of ( "geojson" | "vector" | "raster" | "image" )
Default:
"geojson"

Sets the source type for this layer, that is the type of the layer data.

symbol
Parent:
layout.mapbox.layers[]
Type:
object containing one or more of the keys listed below.
Default:
"marker"

Sets the symbol icon image (mapbox.layer.layout.icon-image). Full list: https://www.mapbox.com/maki-icons/

icon
Parent:
layout.mapbox.layers[].symbol
Type:
string
Default:
"marker"

Sets the symbol icon image (mapbox.layer.layout.icon-image). Full list: https://www.mapbox.com/maki-icons/

iconsize
Parent:
layout.mapbox.layers[].symbol
Type:
number
Default:
10

Sets the symbol icon size (mapbox.layer.layout.icon-size). Has an effect only when `type` is set to "symbol".

placement
Parent:
layout.mapbox.layers[].symbol
Type:
enumerated , one of ( "point" | "line" | "line-center" )
Default:
"point"

Sets the symbol and/or text placement (mapbox.layer.layout.symbol-placement). If `placement` is "point", the label is placed where the geometry is located If `placement` is "line", the label is placed along the line of the geometry If `placement` is "line-center", the label is placed on the center of the geometry

text
Parent:
layout.mapbox.layers[].symbol
Type:
string
Default:
""

Sets the symbol text (mapbox.layer.layout.text-field).

textfont
Parent:
layout.mapbox.layers[].symbol
Type:
object containing one or more of the keys listed below.
Default:
"Open Sans Regular, Arial Unicode MS Regular"

Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol".

color
Parent:
layout.mapbox.layers[].symbol.textfont
Type:
color
family
Parent:
layout.mapbox.layers[].symbol.textfont
Type:
string
Default:
"Open Sans Regular, Arial Unicode MS Regular"

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.mapbox.layers[].symbol.textfont
Type:
number greater than or equal to 1
textposition
Parent:
layout.mapbox.layers[].symbol
Type:
enumerated , 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.

templateitemname
Parent:
layout.mapbox.layers[]
Type:
string

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

type
Parent:
layout.mapbox.layers[]
Type:
enumerated , one of ( "circle" | "line" | "fill" | "symbol" | "raster" )
Default:
"circle"

Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to "geojson", the following values are allowed: "circle", "line", "fill" and "symbol". but note that "line" and "fill" are not compatible with Point GeoJSON geometries. With `sourcetype` set to "vector", the following values are allowed: "circle", "line", "fill" and "symbol". With `sourcetype` set to "raster" or `"image"`, only the "raster" value is allowed.

visible
Parent:
layout.mapbox.layers[]
Type:
boolean
Default:
true

Determines whether this layer is displayed

pitch
Parent:
layout.mapbox
Type:
number
Default:
0

Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch).

style
Parent:
layout.mapbox
Type:
number or categorical coordinate string
Default:
basic

Defines the map layers that are rendered by default below the trace layers defined in `data`, which are themselves by default rendered below the layers defined in `layout.mapbox.layers`. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the `accesstoken` attribute or in the `mapboxAccessToken` config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: open-street-map, white-bg, carto-positron, carto-darkmatter, stamen-terrain, stamen-toner, stamen-watercolor The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox-<name>-<version>

uirevision
Parent:
layout.mapbox
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in the view: `center`, `zoom`, `bearing`, `pitch`. Defaults to `layout.uirevision`.

zoom
Parent:
layout.mapbox
Type:
number
Default:
1

Sets the zoom level of the map (mapbox.zoom).

margin
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
80

Sets the left margin (in px).

autoexpand
Parent:
layout.margin
Type:
boolean
Default:
true

Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults.

b
Parent:
layout.margin
Type:
number greater than or equal to 0
Default:
80

Sets the bottom margin (in px).

l
Parent:
layout.margin
Type:
number greater than or equal to 0
Default:
80

Sets the left margin (in px).

pad
Parent:
layout.margin
Type:
number greater than or equal to 0
Default:
0

Sets the amount of padding (in px) between the plotting area and the axis lines

t
Parent:
layout.margin
Type:
number greater than or equal to 0
Default:
100

Sets the top margin (in px).

meta
Parent:
layout
Type:
number or categorical coordinate string

Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.

modebar
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"h"

Sets the orientation of the modebar.

activecolor
Parent:
layout.modebar
Type:
color

Sets the color of the active or hovered on icons in the modebar.

bgcolor
Parent:
layout.modebar
Type:
color

Sets the background color of the modebar.

color
Parent:
layout.modebar
Type:
color

Sets the color of the icons in the modebar.

orientation
Parent:
layout.modebar
Type:
enumerated , one of ( "v" | "h" )
Default:
"h"

Sets the orientation of the modebar.

uirevision
Parent:
layout.modebar
Type:
number or categorical coordinate string

Controls persistence of user-driven changes related to the modebar, including `hovermode`, `dragmode`, and `showspikes` at both the root level and inside subplots. Defaults to `layout.uirevision`.

orientation
Parent:
layout
Type:
angle

Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given angle in legacy polar charts.

paper_bgcolor
Parent:
layout
Type:
color
Default:
"#fff"

Sets the color of paper where the graph is drawn.

plot_bgcolor
Parent:
layout
Type:
color
Default:
"#fff"

Sets the color of plotting area in-between x and y axes.

polar
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this polar subplot (in plot fraction).

angularaxis
Parent:
layout.polar
Type:
object containing one or more of the keys listed below.
Default:
true

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

categoryarray
Parent:
layout.polar.angularaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.polar.angularaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

direction
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "counterclockwise" | "clockwise" )
Default:
"counterclockwise"

Sets the direction corresponding to positive angles.

dtick
Parent:
layout.polar.angularaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.polar.angularaxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.polar.angularaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.polar.angularaxis
Type:
string
Default:
""

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

layer
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.polar.angularaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.polar.angularaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

nticks
Parent:
layout.polar.angularaxis
Type:
integer greater than or equal to 0
Default:
0

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

period
Parent:
layout.polar.angularaxis
Type:
number greater than or equal to 0

Set the angular period. Has an effect only when `angularaxis.type` is "category".

rotation
Parent:
layout.polar.angularaxis
Type:
angle

Sets that start position (in degrees) of the angular axis By default, polar subplots with `direction` set to "counterclockwise" get a `rotation` of "0" which corresponds to due East (like what mathematicians prefer). In turn, polar with `direction` set to "clockwise" get a rotation of "90" which corresponds to due North (like on a compass),

separatethousands
Parent:
layout.polar.angularaxis
Type:
boolean

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

showexponent
Parent:
layout.polar.angularaxis
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.

showgrid
Parent:
layout.polar.angularaxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.polar.angularaxis
Type:
boolean
Default:
true

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
layout.polar.angularaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.polar.angularaxis
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:
layout.polar.angularaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thetaunit
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "radians" | "degrees" )
Default:
"degrees"

Sets the format unit of the formatted "theta" values. Has an effect only when `angularaxis.type` is "linear".

tick0
Parent:
layout.polar.angularaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.polar.angularaxis
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:
layout.polar.angularaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.polar.angularaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.polar.angularaxis.tickfont
Type:
color
family
Parent:
layout.polar.angularaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.polar.angularaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.polar.angularaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.polar.angularaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.polar.angularaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.polar.angularaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.polar.angularaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.polar.angularaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.polar.angularaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.polar.angularaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.polar.angularaxis
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:
layout.polar.angularaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.polar.angularaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.polar.angularaxis
Type:
data array

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

tickvals
Parent:
layout.polar.angularaxis
Type:
data array

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

tickwidth
Parent:
layout.polar.angularaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

type
Parent:
layout.polar.angularaxis
Type:
enumerated , one of ( "-" | "linear" | "category" )
Default:
"-"

Sets the angular axis type. If "linear", set `thetaunit` to determine the unit in which axis value are shown. If "category, use `period` to set the number of integer coordinates around polar axis.

uirevision
Parent:
layout.polar.angularaxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `rotation`. Defaults to `polar<N>.uirevision`.

visible
Parent:
layout.polar.angularaxis
Type:
boolean
Default:
true

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

bgcolor
Parent:
layout.polar
Type:
color
Default:
"#fff"

Set the background color of the subplot

domain
Parent:
layout.polar
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this polar subplot (in plot fraction).

column
Parent:
layout.polar.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this polar subplot .

row
Parent:
layout.polar.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this polar subplot .

x
Parent:
layout.polar.domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this polar subplot (in plot fraction).

y
Parent:
layout.polar.domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this polar subplot (in plot fraction).

gridshape
Parent:
layout.polar
Type:
enumerated , one of ( "circular" | "linear" )
Default:
"circular"

Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).

hole
Parent:
layout.polar
Type:
number between or equal to 0 and 1
Default:
0

Sets the fraction of the radius to cut out of the polar subplot.

radialaxis
Parent:
layout.polar
Type:
object containing one or more of the keys listed below.
Default:
true

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

angle
Parent:
layout.polar.radialaxis
Type:
angle

Sets the angle (in degrees) from which the radial axis is drawn. Note that by default, radial axis line on the theta=0 line corresponds to a line pointing right (like what mathematicians prefer). Defaults to the first `polar.sector` angle.

autorange
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

calendar
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`

categoryarray
Parent:
layout.polar.radialaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.polar.radialaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.polar.radialaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.polar.radialaxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.polar.radialaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.polar.radialaxis
Type:
string
Default:
""

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

layer
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.polar.radialaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.polar.radialaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

nticks
Parent:
layout.polar.radialaxis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
layout.polar.radialaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "tozero" | "nonnegative" | "normal" )
Default:
"tozero"

If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. If "normal", the range is computed in relation to the extrema of the input data (same behavior as for cartesian axes).

separatethousands
Parent:
layout.polar.radialaxis
Type:
boolean

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

showexponent
Parent:
layout.polar.radialaxis
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.

showgrid
Parent:
layout.polar.radialaxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.polar.radialaxis
Type:
boolean
Default:
true

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
layout.polar.radialaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.polar.radialaxis
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:
layout.polar.radialaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

side
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "clockwise" | "counterclockwise" )
Default:
"clockwise"

Determines on which side of radial axis line the tick and tick labels appear.

tick0
Parent:
layout.polar.radialaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.polar.radialaxis
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:
layout.polar.radialaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.polar.radialaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.polar.radialaxis.tickfont
Type:
color
family
Parent:
layout.polar.radialaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.polar.radialaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.polar.radialaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.polar.radialaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.polar.radialaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.polar.radialaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.polar.radialaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.polar.radialaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.polar.radialaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.polar.radialaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.polar.radialaxis
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:
layout.polar.radialaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.polar.radialaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.polar.radialaxis
Type:
data array

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

tickvals
Parent:
layout.polar.radialaxis
Type:
data array

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

tickwidth
Parent:
layout.polar.radialaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.polar.radialaxis
Type:
object containing one or more of the keys listed below.
Default:
""

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.polar.radialaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.polar.radialaxis.title.font
Type:
color
family
Parent:
layout.polar.radialaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.polar.radialaxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.polar.radialaxis.title
Type:
string
Default:
""

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
layout.polar.radialaxis
Type:
enumerated , one of ( "-" | "linear" | "log" | "date" | "category" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

uirevision
Parent:
layout.polar.radialaxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `range`, `autorange`, `angle`, and `title` if in `editable: true` configuration. Defaults to `polar<N>.uirevision`.

visible
Parent:
layout.polar.radialaxis
Type:
boolean
Default:
true

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

sector
Parent:
layout.polar
Type:
array
Default:
[0, 360]

Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.

uirevision
Parent:
layout.polar
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.

radialaxis
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this radial axis.

domain
Parent:
layout.radialaxis
Type:
array
Default:
[0, 1]

Polar chart subplots are not supported yet. This key has currently no effect.

endpadding
Parent:
layout.radialaxis
Type:
number

Legacy polar charts are deprecated! Please switch to "polar" subplots.

orientation
Parent:
layout.radialaxis
Type:
number

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (an angle with respect to the origin) of the radial axis.

range
Parent:
layout.radialaxis
Type:
array

Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this radial axis.

showline
Parent:
layout.radialaxis
Type:
boolean

Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the line bounding this radial axis will be shown on the figure.

showticklabels
Parent:
layout.radialaxis
Type:
boolean

Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the radial axis ticks will feature tick labels.

tickcolor
Parent:
layout.radialaxis
Type:
color

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the color of the tick lines on this radial axis.

ticklen
Parent:
layout.radialaxis
Type:
number greater than or equal to 0

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this radial axis.

tickorientation
Parent:
layout.radialaxis
Type:
enumerated , one of ( "horizontal" | "vertical" )

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (from the paper perspective) of the radial axis tick labels.

ticksuffix
Parent:
layout.radialaxis
Type:
string

Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this radial axis.

visible
Parent:
layout.radialaxis
Type:
boolean

Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not this axis will be visible.

scene
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"rgba(0,0,0,0)"

Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is "{x: 0, y: 0, z: 1}" which means that the z axis points up.

annotations
Parent:
layout.scene
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this annotation is visible.

align
Parent:
layout.scene.annotations[]
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"center"

Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans more 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.

arrowcolor
Parent:
layout.scene.annotations[]
Type:
color

Sets the color of the annotation arrow.

arrowhead
Parent:
layout.scene.annotations[]
Type:
integer between or equal to 0 and 8
Default:
1

Sets the end annotation arrow head style.

arrowside
Parent:
layout.scene.annotations[]
Type:
flaglist string. Any combination of "end", "start" joined with a "+" OR "none".
Default:
"end"

Sets the annotation arrow head position.

arrowsize
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0.3
Default:
1

Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.

arrowwidth
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0.1

Sets the width (in px) of annotation arrow line.

ax
Parent:
layout.scene.annotations[]
Type:
number

Sets the x component of the arrow tail about the arrow head (in pixels).

ay
Parent:
layout.scene.annotations[]
Type:
number

Sets the y component of the arrow tail about the arrow head (in pixels).

bgcolor
Parent:
layout.scene.annotations[]
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the background color of the annotation.

bordercolor
Parent:
layout.scene.annotations[]
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of the border enclosing the annotation `text`.

borderpad
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0
Default:
1

Sets the padding (in px) between the `text` and the enclosing border.

borderwidth
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the border enclosing the annotation `text`.

captureevents
Parent:
layout.scene.annotations[]
Type:
boolean

Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is "false" unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`.

font
Parent:
layout.scene.annotations[]
Type:
object containing one or more of the keys listed below.

Sets the annotation text font.

color
Parent:
layout.scene.annotations[].font
Type:
color
family
Parent:
layout.scene.annotations[].font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.annotations[].font
Type:
number greater than or equal to 1
height
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 1

Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.

hoverlabel
Parent:
layout.scene.annotations[]
Type:
object containing one or more of the keys listed below.

Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.

bgcolor
Parent:
layout.scene.annotations[].hoverlabel
Type:
color

Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.

bordercolor
Parent:
layout.scene.annotations[].hoverlabel
Type:
color

Sets the border color of the hover label. By default uses either dark grey or white, for maximum contrast with `hoverlabel.bgcolor`.

font
Parent:
layout.scene.annotations[].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the hover label text font. By default uses the global hover font and size, with color from `hoverlabel.bordercolor`.

color
Parent:
layout.scene.annotations[].hoverlabel.font
Type:
color
family
Parent:
layout.scene.annotations[].hoverlabel.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.annotations[].hoverlabel.font
Type:
number greater than or equal to 1
hovertext
Parent:
layout.scene.annotations[]
Type:
string

Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.

name
Parent:
layout.scene.annotations[]
Type:
string

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

opacity
Parent:
layout.scene.annotations[]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the annotation (text + arrow).

showarrow
Parent:
layout.scene.annotations[]
Type:
boolean
Default:
true

Determines whether or not the annotation is drawn with an arrow. If "true", `text` is placed near the arrow's tail. If "false", `text` lines up with the `x` and `y` provided.

standoff
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0
Default:
0

Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.

startarrowhead
Parent:
layout.scene.annotations[]
Type:
integer between or equal to 0 and 8
Default:
1

Sets the start annotation arrow head style.

startarrowsize
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0.3
Default:
1

Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.

startstandoff
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 0
Default:
0

Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.

templateitemname
Parent:
layout.scene.annotations[]
Type:
string

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

text
Parent:
layout.scene.annotations[]
Type:
string

Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.

textangle
Parent:
layout.scene.annotations[]
Type:
angle
Default:
0

Sets the angle at which the `text` is drawn with respect to the horizontal.

valign
Parent:
layout.scene.annotations[]
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height.

visible
Parent:
layout.scene.annotations[]
Type:
boolean
Default:
true

Determines whether or not this annotation is visible.

width
Parent:
layout.scene.annotations[]
Type:
number greater than or equal to 1

Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.

x
Parent:
layout.scene.annotations[]
Type:
number or categorical coordinate string

Sets the annotation's x position.

xanchor
Parent:
layout.scene.annotations[]
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"auto"

Sets the text box's horizontal position anchor This anchor binds the `x` position to the "left", "center" or "right" of the annotation. For example, if `x` is set to 1, `xref` to "paper" and `xanchor` to "right" then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If "auto", the anchor is equivalent to "center" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

xshift
Parent:
layout.scene.annotations[]
Type:
number
Default:
0

Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.

y
Parent:
layout.scene.annotations[]
Type:
number or categorical coordinate string

Sets the annotation's y position.

yanchor
Parent:
layout.scene.annotations[]
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
Default:
"auto"

Sets the text box's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the annotation. For example, if `y` is set to 1, `yref` to "paper" and `yanchor` to "top" then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If "auto", the anchor is equivalent to "middle" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

yshift
Parent:
layout.scene.annotations[]
Type:
number
Default:
0

Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.

z
Parent:
layout.scene.annotations[]
Type:
number or categorical coordinate string

Sets the annotation's z position.

aspectmode
Parent:
layout.scene
Type:
enumerated , one of ( "auto" | "cube" | "data" | "manual" )
Default:
"auto"

If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used.

aspectratio
Parent:
layout.scene
Type:
object containing one or more of the keys listed below.

Sets this scene's axis aspectratio.

x
Parent:
layout.scene.aspectratio
Type:
number greater than or equal to 0
y
Parent:
layout.scene.aspectratio
Type:
number greater than or equal to 0
z
Parent:
layout.scene.aspectratio
Type:
number greater than or equal to 0
bgcolor
Parent:
layout.scene
Type:
color
Default:
"rgba(0,0,0,0)"
camera
Parent:
layout.scene
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is "{x: 0, y: 0, z: 1}" which means that the z axis points up.

center
Parent:
layout.scene.camera
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the (x,y,z) components of the 'center' camera vector This vector determines the translation (x,y,z) space about the center of this scene. By default, there is no such translation.

x
Parent:
layout.scene.camera.center
Type:
number
Default:
0
y
Parent:
layout.scene.camera.center
Type:
number
Default:
0
z
Parent:
layout.scene.camera.center
Type:
number
Default:
0
eye
Parent:
layout.scene.camera
Type:
object containing one or more of the keys listed below.
Default:
1.25

Sets the (x,y,z) components of the 'eye' camera vector. This vector determines the view point about the origin of this scene.

x
Parent:
layout.scene.camera.eye
Type:
number
Default:
1.25
y
Parent:
layout.scene.camera.eye
Type:
number
Default:
1.25
z
Parent:
layout.scene.camera.eye
Type:
number
Default:
1.25
projection
Parent:
layout.scene.camera
Type:
object containing one or more of the keys listed below.
Default:
"perspective"

Sets the projection type. The projection type could be either "perspective" or "orthographic". The default is "perspective".

type
Parent:
layout.scene.camera.projection
Type:
enumerated , one of ( "perspective" | "orthographic" )
Default:
"perspective"

Sets the projection type. The projection type could be either "perspective" or "orthographic". The default is "perspective".

up
Parent:
layout.scene.camera
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is "{x: 0, y: 0, z: 1}" which means that the z axis points up.

x
Parent:
layout.scene.camera.up
Type:
number
Default:
0
y
Parent:
layout.scene.camera.up
Type:
number
Default:
0
z
Parent:
layout.scene.camera.up
Type:
number
Default:
1
domain
Parent:
layout.scene
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this scene subplot (in plot fraction).

column
Parent:
layout.scene.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this scene subplot .

row
Parent:
layout.scene.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this scene subplot .

x
Parent:
layout.scene.domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this scene subplot (in plot fraction).

y
Parent:
layout.scene.domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this scene subplot (in plot fraction).

dragmode
Parent:
layout.scene
Type:
enumerated , one of ( "orbit" | "turntable" | "zoom" | "pan" | false )

Determines the mode of drag interactions for this scene.

hovermode
Parent:
layout.scene
Type:
enumerated , one of ( "closest" | false )
Default:
"closest"

Determines the mode of hover interactions for this scene.

uirevision
Parent:
layout.scene
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`.

xaxis
Parent:
layout.scene
Type:
object containing one or more of the keys listed below.
Default:
true

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

autorange
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

backgroundcolor
Parent:
layout.scene.xaxis
Type:
color
Default:
"rgba(204, 204, 204, 0.5)"

Sets the background color of this axis' wall.

calendar
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`

categoryarray
Parent:
layout.scene.xaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.scene.xaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.scene.xaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.scene.xaxis
Type:
color
Default:
"rgb(204, 204, 204)"

Sets the color of the grid lines.

gridwidth
Parent:
layout.scene.xaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.scene.xaxis
Type:
string
Default:
""

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

linecolor
Parent:
layout.scene.xaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.scene.xaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

mirror
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( true | "ticks" | false | "all" | "allticks" )

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.

nticks
Parent:
layout.scene.xaxis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
layout.scene.xaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.

separatethousands
Parent:
layout.scene.xaxis
Type:
boolean

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

showaxeslabels
Parent:
layout.scene.xaxis
Type:
boolean
Default:
true

Sets whether or not this axis is labeled

showbackground
Parent:
layout.scene.xaxis
Type:
boolean

Sets whether or not this axis' wall has a background color.

showexponent
Parent:
layout.scene.xaxis
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.

showgrid
Parent:
layout.scene.xaxis
Type:
boolean

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.scene.xaxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showspikes
Parent:
layout.scene.xaxis
Type:
boolean
Default:
true

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

showticklabels
Parent:
layout.scene.xaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.scene.xaxis
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:
layout.scene.xaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

spikecolor
Parent:
layout.scene.xaxis
Type:
color
Default:
"#444"

Sets the color of the spikes.

spikesides
Parent:
layout.scene.xaxis
Type:
boolean
Default:
true

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

spikethickness
Parent:
layout.scene.xaxis
Type:
number greater than or equal to 0
Default:
2

Sets the thickness (in px) of the spikes.

tick0
Parent:
layout.scene.xaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.scene.xaxis
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:
layout.scene.xaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.scene.xaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.scene.xaxis.tickfont
Type:
color
family
Parent:
layout.scene.xaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.xaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.scene.xaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.scene.xaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.scene.xaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.scene.xaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.scene.xaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.scene.xaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.scene.xaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.scene.xaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.scene.xaxis
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:
layout.scene.xaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.scene.xaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.scene.xaxis
Type:
data array

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

tickvals
Parent:
layout.scene.xaxis
Type:
data array

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

tickwidth
Parent:
layout.scene.xaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.scene.xaxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.scene.xaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.scene.xaxis.title.font
Type:
color
family
Parent:
layout.scene.xaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.xaxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.scene.xaxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
layout.scene.xaxis
Type:
enumerated , one of ( "-" | "linear" | "log" | "date" | "category" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

visible
Parent:
layout.scene.xaxis
Type:
boolean

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

zeroline
Parent:
layout.scene.xaxis
Type:
boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.

zerolinecolor
Parent:
layout.scene.xaxis
Type:
color
Default:
"#444"

Sets the line color of the zero line.

zerolinewidth
Parent:
layout.scene.xaxis
Type:
number
Default:
1

Sets the width (in px) of the zero line.

yaxis
Parent:
layout.scene
Type:
object containing one or more of the keys listed below.
Default:
true

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

autorange
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

backgroundcolor
Parent:
layout.scene.yaxis
Type:
color
Default:
"rgba(204, 204, 204, 0.5)"

Sets the background color of this axis' wall.

calendar
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`

categoryarray
Parent:
layout.scene.yaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.scene.yaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.scene.yaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.scene.yaxis
Type:
color
Default:
"rgb(204, 204, 204)"

Sets the color of the grid lines.

gridwidth
Parent:
layout.scene.yaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.scene.yaxis
Type:
string
Default:
""

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

linecolor
Parent:
layout.scene.yaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.scene.yaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

mirror
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( true | "ticks" | false | "all" | "allticks" )

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.

nticks
Parent:
layout.scene.yaxis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
layout.scene.yaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.

separatethousands
Parent:
layout.scene.yaxis
Type:
boolean

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

showaxeslabels
Parent:
layout.scene.yaxis
Type:
boolean
Default:
true

Sets whether or not this axis is labeled

showbackground
Parent:
layout.scene.yaxis
Type:
boolean

Sets whether or not this axis' wall has a background color.

showexponent
Parent:
layout.scene.yaxis
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.

showgrid
Parent:
layout.scene.yaxis
Type:
boolean

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.scene.yaxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showspikes
Parent:
layout.scene.yaxis
Type:
boolean
Default:
true

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

showticklabels
Parent:
layout.scene.yaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.scene.yaxis
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:
layout.scene.yaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

spikecolor
Parent:
layout.scene.yaxis
Type:
color
Default:
"#444"

Sets the color of the spikes.

spikesides
Parent:
layout.scene.yaxis
Type:
boolean
Default:
true

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

spikethickness
Parent:
layout.scene.yaxis
Type:
number greater than or equal to 0
Default:
2

Sets the thickness (in px) of the spikes.

tick0
Parent:
layout.scene.yaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.scene.yaxis
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:
layout.scene.yaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.scene.yaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.scene.yaxis.tickfont
Type:
color
family
Parent:
layout.scene.yaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.yaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.scene.yaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.scene.yaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.scene.yaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.scene.yaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.scene.yaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.scene.yaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.scene.yaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.scene.yaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.scene.yaxis
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:
layout.scene.yaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.scene.yaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.scene.yaxis
Type:
data array

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

tickvals
Parent:
layout.scene.yaxis
Type:
data array

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

tickwidth
Parent:
layout.scene.yaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.scene.yaxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.scene.yaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.scene.yaxis.title.font
Type:
color
family
Parent:
layout.scene.yaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.yaxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.scene.yaxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
layout.scene.yaxis
Type:
enumerated , one of ( "-" | "linear" | "log" | "date" | "category" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

visible
Parent:
layout.scene.yaxis
Type:
boolean

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

zeroline
Parent:
layout.scene.yaxis
Type:
boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.

zerolinecolor
Parent:
layout.scene.yaxis
Type:
color
Default:
"#444"

Sets the line color of the zero line.

zerolinewidth
Parent:
layout.scene.yaxis
Type:
number
Default:
1

Sets the width (in px) of the zero line.

zaxis
Parent:
layout.scene
Type:
object containing one or more of the keys listed below.
Default:
true

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

autorange
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

backgroundcolor
Parent:
layout.scene.zaxis
Type:
color
Default:
"rgba(204, 204, 204, 0.5)"

Sets the background color of this axis' wall.

calendar
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`

categoryarray
Parent:
layout.scene.zaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.scene.zaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.scene.zaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.scene.zaxis
Type:
color
Default:
"rgb(204, 204, 204)"

Sets the color of the grid lines.

gridwidth
Parent:
layout.scene.zaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.scene.zaxis
Type:
string
Default:
""

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

linecolor
Parent:
layout.scene.zaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.scene.zaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

mirror
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( true | "ticks" | false | "all" | "allticks" )

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.

nticks
Parent:
layout.scene.zaxis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
layout.scene.zaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.

separatethousands
Parent:
layout.scene.zaxis
Type:
boolean

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

showaxeslabels
Parent:
layout.scene.zaxis
Type:
boolean
Default:
true

Sets whether or not this axis is labeled

showbackground
Parent:
layout.scene.zaxis
Type:
boolean

Sets whether or not this axis' wall has a background color.

showexponent
Parent:
layout.scene.zaxis
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.

showgrid
Parent:
layout.scene.zaxis
Type:
boolean

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.scene.zaxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showspikes
Parent:
layout.scene.zaxis
Type:
boolean
Default:
true

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

showticklabels
Parent:
layout.scene.zaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.scene.zaxis
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:
layout.scene.zaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

spikecolor
Parent:
layout.scene.zaxis
Type:
color
Default:
"#444"

Sets the color of the spikes.

spikesides
Parent:
layout.scene.zaxis
Type:
boolean
Default:
true

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

spikethickness
Parent:
layout.scene.zaxis
Type:
number greater than or equal to 0
Default:
2

Sets the thickness (in px) of the spikes.

tick0
Parent:
layout.scene.zaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.scene.zaxis
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:
layout.scene.zaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.scene.zaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.scene.zaxis.tickfont
Type:
color
family
Parent:
layout.scene.zaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.zaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.scene.zaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.scene.zaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.scene.zaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.scene.zaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.scene.zaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.scene.zaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.scene.zaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.scene.zaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.scene.zaxis
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:
layout.scene.zaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.scene.zaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.scene.zaxis
Type:
data array

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

tickvals
Parent:
layout.scene.zaxis
Type:
data array

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

tickwidth
Parent:
layout.scene.zaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.scene.zaxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.scene.zaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.scene.zaxis.title.font
Type:
color
family
Parent:
layout.scene.zaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.scene.zaxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.scene.zaxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
layout.scene.zaxis
Type:
enumerated , one of ( "-" | "linear" | "log" | "date" | "category" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

visible
Parent:
layout.scene.zaxis
Type:
boolean

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

zeroline
Parent:
layout.scene.zaxis
Type:
boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.

zerolinecolor
Parent:
layout.scene.zaxis
Type:
color
Default:
"#444"

Sets the line color of the zero line.

zerolinewidth
Parent:
layout.scene.zaxis
Type:
number
Default:
1

Sets the width (in px) of the zero line.

selectdirection
Parent:
layout
Type:
enumerated , one of ( "h" | "v" | "d" | "any" )
Default:
"any"

When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.

selectionrevision
Parent:
layout
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in selected points from all traces.

separators
Parent:
layout
Type:
string

Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.

shapes
Parent:
layout
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this shape is visible.

fillcolor
Parent:
layout.shapes[]
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color filling the shape's interior.

layer
Parent:
layout.shapes[]
Type:
enumerated , one of ( "below" | "above" )
Default:
"above"

Specifies whether shapes are drawn below or above traces.

line
Parent:
layout.shapes[]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
layout.shapes[].line
Type:
color

Sets the line color.

dash
Parent:
layout.shapes[].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:
layout.shapes[].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

name
Parent:
layout.shapes[]
Type:
string

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

opacity
Parent:
layout.shapes[]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the shape.

path
Parent:
layout.shapes[]
Type:
string

For `type` "path" - a valid SVG path with the pixel values replaced by data values in `xsizemode`/`ysizemode` being "scaled" and taken unmodified as pixels relative to `xanchor` and `yanchor` in case of "pixel" size mode. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained "polybezier" commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can't use either to separate date from time parts. Therefore we'll use underscore for this purpose: 2015-02-21_13:45:56.789

templateitemname
Parent:
layout.shapes[]
Type:
string

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

type
Parent:
layout.shapes[]
Type:
enumerated , one of ( "circle" | "rect" | "path" | "line" )

Specifies the shape type to be drawn. If "line", a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' sizing mode. If "circle", a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing mode. If "rect", a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to the axes' sizing mode. If "path", draw a custom SVG path using `path`. with respect to the axes' sizing mode.

visible
Parent:
layout.shapes[]
Type:
boolean
Default:
true

Determines whether or not this shape is visible.

x0
Parent:
layout.shapes[]
Type:
number or categorical coordinate string

Sets the shape's starting x position. See `type` and `xsizemode` for more info.

x1
Parent:
layout.shapes[]
Type:
number or categorical coordinate string

Sets the shape's end x position. See `type` and `xsizemode` for more info.

xanchor
Parent:
layout.shapes[]
Type:
number or categorical coordinate string

Only relevant in conjunction with `xsizemode` set to "pixel". Specifies the anchor point on the x axis to which `x0`, `x1` and x coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `xsizemode` not set to "pixel".

xref
Parent:
layout.shapes[]
Type:
enumerated , one of ( "paper" | "/^x([2-9]|[1-9][0-9]+)?$/" )

Sets the shape's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate. If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where "0" ("1") corresponds to the left (right) side. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", then you must convert the date to unix time in milliseconds.

xsizemode
Parent:
layout.shapes[]
Type:
enumerated , one of ( "scaled" | "pixel" )
Default:
"scaled"

Sets the shapes's sizing mode along the x axis. If set to "scaled", `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to "paper"). If set to "pixel", `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.

y0
Parent:
layout.shapes[]
Type:
number or categorical coordinate string

Sets the shape's starting y position. See `type` and `ysizemode` for more info.

y1
Parent:
layout.shapes[]
Type:
number or categorical coordinate string

Sets the shape's end y position. See `type` and `ysizemode` for more info.

yanchor
Parent:
layout.shapes[]
Type:
number or categorical coordinate string

Only relevant in conjunction with `ysizemode` set to "pixel". Specifies the anchor point on the y axis to which `y0`, `y1` and y coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `ysizemode` not set to "pixel".

yref
Parent:
layout.shapes[]
Type:
enumerated , one of ( "paper" | "/^y([2-9]|[1-9][0-9]+)?$/" )

Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where "0" ("1") corresponds to the bottom (top).

ysizemode
Parent:
layout.shapes[]
Type:
enumerated , one of ( "scaled" | "pixel" )
Default:
"scaled"

Sets the shapes's sizing mode along the y axis. If set to "scaled", `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to "paper"). If set to "pixel", `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.

showlegend
Parent:
layout
Type:
boolean

Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.

sliders
Parent:
layout
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not the slider is visible.

active
Parent:
layout.sliders[]
Type:
number greater than or equal to 0
Default:
0

Determines which button (by index starting from 0) is considered active.

activebgcolor
Parent:
layout.sliders[]
Type:
color
Default:
"#dbdde0"

Sets the background color of the slider grip while dragging.

bgcolor
Parent:
layout.sliders[]
Type:
color
Default:
"#f8fafc"

Sets the background color of the slider.

bordercolor
Parent:
layout.sliders[]
Type:
color
Default:
"#bec8d9"

Sets the color of the border enclosing the slider.

borderwidth
Parent:
layout.sliders[]
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the border enclosing the slider.

currentvalue
Parent:
layout.sliders[]
Type:
object containing one or more of the keys listed below.
Default:
true

Shows the currently-selected value above the slider.

font
Parent:
layout.sliders[].currentvalue
Type:
object containing one or more of the keys listed below.

Sets the font of the current value label text.

color
Parent:
layout.sliders[].currentvalue.font
Type:
color
family
Parent:
layout.sliders[].currentvalue.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.sliders[].currentvalue.font
Type:
number greater than or equal to 1
offset
Parent:
layout.sliders[].currentvalue
Type:
number
Default:
10

The amount of space, in pixels, between the current value label and the slider.

prefix
Parent:
layout.sliders[].currentvalue
Type:
string

When currentvalue.visible is true, this sets the prefix of the label.

suffix
Parent:
layout.sliders[].currentvalue
Type:
string

When currentvalue.visible is true, this sets the suffix of the label.

visible
Parent:
layout.sliders[].currentvalue
Type:
boolean
Default:
true

Shows the currently-selected value above the slider.

xanchor
Parent:
layout.sliders[].currentvalue
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

The alignment of the value readout relative to the length of the slider.

font
Parent:
layout.sliders[]
Type:
object containing one or more of the keys listed below.

Sets the font of the slider step labels.

color
Parent:
layout.sliders[].font
Type:
color
family
Parent:
layout.sliders[].font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.sliders[].font
Type:
number greater than or equal to 1
len
Parent:
layout.sliders[]
Type:
number greater than or equal to 0
Default:
1

Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.

lenmode
Parent:
layout.sliders[]
Type:
enumerated , one of ( "fraction" | "pixels" )
Default:
"fraction"

Determines whether this slider length is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

minorticklen
Parent:
layout.sliders[]
Type:
number greater than or equal to 0
Default:
4

Sets the length in pixels of minor step tick marks

name
Parent:
layout.sliders[]
Type:
string

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

pad
Parent:
layout.sliders[]
Type:
object containing one or more of the keys listed below.
Default:
20

Set the padding of the slider component along each side.

b
Parent:
layout.sliders[].pad
Type:
number
Default:
0

The amount of padding (in px) along the bottom of the component.

l
Parent:
layout.sliders[].pad
Type:
number
Default:
0

The amount of padding (in px) on the left side of the component.

t
Parent:
layout.sliders[].pad
Type:
number
Default:
20

The amount of padding (in px) along the top of the component.

steps
Parent:
layout.sliders[]
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this step is included in the slider.

args
Parent:
layout.sliders[].steps[]
Type:
array

Sets the arguments values to be passed to the Plotly method set in `method` on slide.

execute
Parent:
layout.sliders[].steps[]
Type:
boolean
Default:
true

When true, the API method is executed. When false, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the `plotly_sliderchange` method and executing the API command manually without losing the benefit of the slider automatically binding to the state of the plot through the specification of `method` and `args`.

label
Parent:
layout.sliders[].steps[]
Type:
string

Sets the text label to appear on the slider

method
Parent:
layout.sliders[].steps[]
Type:
enumerated , one of ( "restyle" | "relayout" | "animate" | "update" | "skip" )
Default:
"restyle"

Sets the Plotly method to be called when the slider value is changed. If the `skip` method is used, the API slider will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to slider events manually via JavaScript.

name
Parent:
layout.sliders[].steps[]
Type:
string

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

templateitemname
Parent:
layout.sliders[].steps[]
Type:
string

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

value
Parent:
layout.sliders[].steps[]
Type:
string

Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.

visible
Parent:
layout.sliders[].steps[]
Type:
boolean
Default:
true

Determines whether or not this step is included in the slider.

templateitemname
Parent:
layout.sliders[]
Type:
string

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

tickcolor
Parent:
layout.sliders[]
Type:
color
Default:
"#333"

Sets the color of the border enclosing the slider.

ticklen
Parent:
layout.sliders[]
Type:
number greater than or equal to 0
Default:
7

Sets the length in pixels of step tick marks

tickwidth
Parent:
layout.sliders[]
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

transition
Parent:
layout.sliders[]
Type:
object containing one or more of the keys listed below.
Default:
150

Sets the duration of the slider transition

duration
Parent:
layout.sliders[].transition
Type:
number greater than or equal to 0
Default:
150

Sets the duration of the slider transition

easing
Parent:
layout.sliders[].transition
Type:
enumerated , one of ( "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out" )
Default:
"cubic-in-out"

Sets the easing function of the slider transition

visible
Parent:
layout.sliders[]
Type:
boolean
Default:
true

Determines whether or not the slider is visible.

x
Parent:
layout.sliders[]
Type:
number between or equal to -2 and 3
Default:
0

Sets the x position (in normalized coordinates) of the slider.

xanchor
Parent:
layout.sliders[]
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"left"

Sets the slider's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.

y
Parent:
layout.sliders[]
Type:
number between or equal to -2 and 3
Default:
0

Sets the y position (in normalized coordinates) of the slider.

yanchor
Parent:
layout.sliders[]
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
Default:
"top"

Sets the slider's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.

spikedistance
Parent:
layout
Type:
integer greater than or equal to -1
Default:
20

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

template
Parent:
layout
Type:
number or categorical coordinate string

Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.

ternary
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this ternary subplot (in plot fraction).

aaxis
Parent:
layout.ternary
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

color
Parent:
layout.ternary.aaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.ternary.aaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.ternary.aaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.ternary.aaxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.ternary.aaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.ternary.aaxis
Type:
string
Default:
""

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

layer
Parent:
layout.ternary.aaxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.ternary.aaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.ternary.aaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

min
Parent:
layout.ternary.aaxis
Type:
number greater than or equal to 0
Default:
0

The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.

nticks
Parent:
layout.ternary.aaxis
Type:
integer greater than or equal to 1
Default:
6

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

separatethousands
Parent:
layout.ternary.aaxis
Type:
boolean

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

showexponent
Parent:
layout.ternary.aaxis
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.

showgrid
Parent:
layout.ternary.aaxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.ternary.aaxis
Type:
boolean
Default:
true

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
layout.ternary.aaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.ternary.aaxis
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:
layout.ternary.aaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

tick0
Parent:
layout.ternary.aaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.ternary.aaxis
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:
layout.ternary.aaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.ternary.aaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.ternary.aaxis.tickfont
Type:
color
family
Parent:
layout.ternary.aaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.ternary.aaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.ternary.aaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.ternary.aaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.ternary.aaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.ternary.aaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.ternary.aaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.ternary.aaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.ternary.aaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.ternary.aaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.ternary.aaxis
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:
layout.ternary.aaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.ternary.aaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.ternary.aaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.ternary.aaxis
Type:
data array

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

tickvals
Parent:
layout.ternary.aaxis
Type:
data array

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

tickwidth
Parent:
layout.ternary.aaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.ternary.aaxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.ternary.aaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.ternary.aaxis.title.font
Type:
color
family
Parent:
layout.ternary.aaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.ternary.aaxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.ternary.aaxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

uirevision
Parent:
layout.ternary.aaxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `min`, and `title` if in `editable: true` configuration. Defaults to `ternary<N>.uirevision`.

baxis
Parent:
layout.ternary
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

color
Parent:
layout.ternary.baxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.ternary.baxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.ternary.baxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.ternary.baxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.ternary.baxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.ternary.baxis
Type:
string
Default:
""

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

layer
Parent:
layout.ternary.baxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.ternary.baxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.ternary.baxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

min
Parent:
layout.ternary.baxis
Type:
number greater than or equal to 0
Default:
0

The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.

nticks
Parent:
layout.ternary.baxis
Type:
integer greater than or equal to 1
Default:
6

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

separatethousands
Parent:
layout.ternary.baxis
Type:
boolean

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

showexponent
Parent:
layout.ternary.baxis
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.

showgrid
Parent:
layout.ternary.baxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.ternary.baxis
Type:
boolean
Default:
true

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
layout.ternary.baxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.ternary.baxis
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:
layout.ternary.baxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

tick0
Parent:
layout.ternary.baxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.ternary.baxis
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:
layout.ternary.baxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.ternary.baxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.ternary.baxis.tickfont
Type:
color
family
Parent:
layout.ternary.baxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.ternary.baxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.ternary.baxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.ternary.baxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.ternary.baxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.ternary.baxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.ternary.baxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.ternary.baxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.ternary.baxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.ternary.baxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.ternary.baxis
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:
layout.ternary.baxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.ternary.baxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.ternary.baxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.ternary.baxis
Type:
data array

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

tickvals
Parent:
layout.ternary.baxis
Type:
data array

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

tickwidth
Parent:
layout.ternary.baxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.ternary.baxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.ternary.baxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.ternary.baxis.title.font
Type:
color
family
Parent:
layout.ternary.baxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.ternary.baxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.ternary.baxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

uirevision
Parent:
layout.ternary.baxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `min`, and `title` if in `editable: true` configuration. Defaults to `ternary<N>.uirevision`.

bgcolor
Parent:
layout.ternary
Type:
color
Default:
"#fff"

Set the background color of the subplot

caxis
Parent:
layout.ternary
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

color
Parent:
layout.ternary.caxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
layout.ternary.caxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.ternary.caxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

gridcolor
Parent:
layout.ternary.caxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.ternary.caxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.ternary.caxis
Type:
string
Default:
""

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

layer
Parent:
layout.ternary.caxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.ternary.caxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.ternary.caxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

min
Parent:
layout.ternary.caxis
Type:
number greater than or equal to 0
Default:
0

The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.

nticks
Parent:
layout.ternary.caxis
Type:
integer greater than or equal to 1
Default:
6

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

separatethousands
Parent:
layout.ternary.caxis
Type:
boolean

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

showexponent
Parent:
layout.ternary.caxis
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.

showgrid
Parent:
layout.ternary.caxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.ternary.caxis
Type:
boolean
Default:
true

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
layout.ternary.caxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.ternary.caxis
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:
layout.ternary.caxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

tick0
Parent:
layout.ternary.caxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.ternary.caxis
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:
layout.ternary.caxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.ternary.caxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.ternary.caxis.tickfont
Type:
color
family
Parent:
layout.ternary.caxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.ternary.caxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.ternary.caxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.ternary.caxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.ternary.caxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.ternary.caxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.ternary.caxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.ternary.caxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.ternary.caxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.ternary.caxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.ternary.caxis
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:
layout.ternary.caxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.ternary.caxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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:
layout.ternary.caxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.ternary.caxis
Type:
data array

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

tickvals
Parent:
layout.ternary.caxis
Type:
data array

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

tickwidth
Parent:
layout.ternary.caxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.ternary.caxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.ternary.caxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.ternary.caxis.title.font
Type:
color
family
Parent:
layout.ternary.caxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.ternary.caxis.title.font
Type:
number greater than or equal to 1
text
Parent:
layout.ternary.caxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

uirevision
Parent:
layout.ternary.caxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `min`, and `title` if in `editable: true` configuration. Defaults to `ternary<N>.uirevision`.

domain
Parent:
layout.ternary
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this ternary subplot (in plot fraction).

column
Parent:
layout.ternary.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this ternary subplot .

row
Parent:
layout.ternary.domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this ternary subplot .

x
Parent:
layout.ternary.domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this ternary subplot (in plot fraction).

y
Parent:
layout.ternary.domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this ternary subplot (in plot fraction).

sum
Parent:
layout.ternary
Type:
number greater than or equal to 0
Default:
1

The number each triplet should sum to, and the maximum range of each axis

uirevision
Parent:
layout.ternary
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `min` and `title`, if not overridden in the individual axes. Defaults to `layout.uirevision`.

title
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"container"

Sets the plot's title. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.title
Type:
object containing one or more of the keys listed below.

Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.title.font
Type:
color
family
Parent:
layout.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.title.font
Type:
number greater than or equal to 1
pad
Parent:
layout.title
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the padding of the title. Each padding value only applies when the corresponding `xanchor`/`yanchor` value is set accordingly. E.g. for left padding to take effect, `xanchor` must be set to "left". The same rule applies if `xanchor`/`yanchor` is determined automatically. Padding is muted if the respective anchor value is "middle"/"center".

b
Parent:
layout.title.pad
Type:
number
Default:
0

The amount of padding (in px) along the bottom of the component.

l
Parent:
layout.title.pad
Type:
number
Default:
0

The amount of padding (in px) on the left side of the component.

t
Parent:
layout.title.pad
Type:
number
Default:
0

The amount of padding (in px) along the top of the component.

text
Parent:
layout.title
Type:
string

Sets the plot's title. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
layout.title
Type:
number between or equal to 0 and 1
Default:
0.5

Sets the x position with respect to `xref` in normalized coordinates from "0" (left) to "1" (right).

xanchor
Parent:
layout.title
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"auto"

Sets the title's horizontal alignment with respect to its x position. "left" means that the title starts at x, "right" means that the title ends at x and "center" means that the title's center is at x. "auto" divides `xref` by three and calculates the `xanchor` value automatically based on the value of `x`.

xref
Parent:
layout.title
Type:
enumerated , one of ( "container" | "paper" )
Default:
"container"

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:
layout.title
Type:
number between or equal to 0 and 1
Default:
"auto"

Sets the y position with respect to `yref` in normalized coordinates from "0" (bottom) to "1" (top). "auto" places the baseline of the title onto the vertical center of the top margin.

yanchor
Parent:
layout.title
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
Default:
"auto"

Sets the title's vertical alignment with respect to its y position. "top" means that the title's cap line is at y, "bottom" means that the title's baseline is at y and "middle" means that the title's midline is at y. "auto" divides `yref` by three and calculates the `yanchor` value automatically based on the value of `y`.

yref
Parent:
layout.title
Type:
enumerated , one of ( "container" | "paper" )
Default:
"container"

Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.

transition
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
500

Sets transition options used during Plotly.react updates.

duration
Parent:
layout.transition
Type:
number greater than or equal to 0
Default:
500

The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.

easing
Parent:
layout.transition
Type:
enumerated , one of ( "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out" )
Default:
"cubic-in-out"

The easing function used for the transition

ordering
Parent:
layout.transition
Type:
enumerated , one of ( "layout first" | "traces first" )
Default:
"layout first"

Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change.

uirevision
Parent:
layout
Type:
number or categorical coordinate string

Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.

updatemenus
Parent:
layout
Type:
array of object where each object has one or more of the keys listed below.
Default:
"dropdown"

Determines whether or not the update menu is visible.

active
Parent:
layout.updatemenus[]
Type:
integer greater than or equal to -1
Default:
0

Determines which button (by index starting from 0) is considered active.

bgcolor
Parent:
layout.updatemenus[]
Type:
color

Sets the background color of the update menu buttons.

bordercolor
Parent:
layout.updatemenus[]
Type:
color
Default:
"#BEC8D9"

Sets the color of the border enclosing the update menu.

borderwidth
Parent:
layout.updatemenus[]
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the border enclosing the update menu.

buttons
Parent:
layout.updatemenus[]
Type:
array of object where each object has one or more of the keys listed below.
Default:
"restyle"

Determines whether or not this button is visible.

args
Parent:
layout.updatemenus[].buttons[]
Type:
array

Sets the arguments values to be passed to the Plotly method set in `method` on click.

args2
Parent:
layout.updatemenus[].buttons[]
Type:
array

Sets a 2nd set of `args`, these arguments values are passed to the Plotly method set in `method` when clicking this button while in the active state. Use this to create toggle buttons.

execute
Parent:
layout.updatemenus[].buttons[]
Type:
boolean
Default:
true

When true, the API method is executed. When false, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the `plotly_buttonclicked` method and executing the API command manually without losing the benefit of the updatemenu automatically binding to the state of the plot through the specification of `method` and `args`.

label
Parent:
layout.updatemenus[].buttons[]
Type:
string
Default:
""

Sets the text label to appear on the button.

method
Parent:
layout.updatemenus[].buttons[]
Type:
enumerated , one of ( "restyle" | "relayout" | "animate" | "update" | "skip" )
Default:
"restyle"

Sets the Plotly method to be called on click. If the `skip` method is used, the API updatemenu will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to updatemenu events manually via JavaScript.

name
Parent:
layout.updatemenus[].buttons[]
Type:
string

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

templateitemname
Parent:
layout.updatemenus[].buttons[]
Type:
string

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

visible
Parent:
layout.updatemenus[].buttons[]
Type:
boolean

Determines whether or not this button is visible.

direction
Parent:
layout.updatemenus[]
Type:
enumerated , one of ( "left" | "right" | "up" | "down" )
Default:
"down"

Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For `left` and `up`, the buttons will still appear in left-to-right or top-to-bottom order respectively.

font
Parent:
layout.updatemenus[]
Type:
object containing one or more of the keys listed below.

Sets the font of the update menu button text.

color
Parent:
layout.updatemenus[].font
Type:
color
family
Parent:
layout.updatemenus[].font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.updatemenus[].font
Type:
number greater than or equal to 1
name
Parent:
layout.updatemenus[]
Type:
string

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

pad
Parent:
layout.updatemenus[]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the padding around the buttons or dropdown menu.

b
Parent:
layout.updatemenus[].pad
Type:
number
Default:
0

The amount of padding (in px) along the bottom of the component.

l
Parent:
layout.updatemenus[].pad
Type:
number
Default:
0

The amount of padding (in px) on the left side of the component.

t
Parent:
layout.updatemenus[].pad
Type:
number
Default:
0

The amount of padding (in px) along the top of the component.

showactive
Parent:
layout.updatemenus[]
Type:
boolean
Default:
true

Highlights active dropdown item or active button if true.

templateitemname
Parent:
layout.updatemenus[]
Type:
string

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

type
Parent:
layout.updatemenus[]
Type:
enumerated , one of ( "dropdown" | "buttons" )
Default:
"dropdown"

Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically

visible
Parent:
layout.updatemenus[]
Type:
boolean

Determines whether or not the update menu is visible.

x
Parent:
layout.updatemenus[]
Type:
number between or equal to -2 and 3
Default:
-0.05

Sets the x position (in normalized coordinates) of the update menu.

xanchor
Parent:
layout.updatemenus[]
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"right"

Sets the update menu's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.

y
Parent:
layout.updatemenus[]
Type:
number between or equal to -2 and 3
Default:
1

Sets the y position (in normalized coordinates) of the update menu.

yanchor
Parent:
layout.updatemenus[]
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
Default:
"top"

Sets the update menu's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.

width
Parent:
layout
Type:
number greater than or equal to 10
Default:
700

Sets the plot's width (in px).

xaxis
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"#444"

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

anchor
Parent:
layout.xaxis
Type:
enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.

automargin
Parent:
layout.xaxis
Type:
boolean

Determines whether long tick labels automatically grow the figure margins.

autorange
Parent:
layout.xaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

calendar
Parent:
layout.xaxis
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`

categoryarray
Parent:
layout.xaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.xaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.xaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

constrain
Parent:
layout.xaxis
Type:
enumerated , one of ( "range" | "domain" )
Default:
"range"

If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range" (default), or by decreasing the "domain".

constraintoward
Parent:
layout.xaxis
Type:
enumerated , one of ( "left" | "center" | "right" | "top" | "middle" | "bottom" )

If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.

dividercolor
Parent:
layout.xaxis
Type:
color
Default:
"#444"

Sets the color of the dividers Only has an effect on "multicategory" axes.

dividerwidth
Parent:
layout.xaxis
Type:
number
Default:
1

Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.

domain
Parent:
layout.xaxis
Type:
array
Default:
[0, 1]

Sets the domain of this axis (in plot fraction).

dtick
Parent:
layout.xaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.xaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

fixedrange
Parent:
layout.xaxis
Type:
boolean

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

gridcolor
Parent:
layout.xaxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.xaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.xaxis
Type:
string
Default:
""

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

layer
Parent:
layout.xaxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.xaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.xaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

matches
Parent:
layout.xaxis
Type:
enumerated , one of ( "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.

mirror
Parent:
layout.xaxis
Type:
enumerated , one of ( true | "ticks" | false | "all" | "allticks" )

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.

nticks
Parent:
layout.xaxis
Type:
integer greater than or equal to 0
Default:
0

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

overlaying
Parent:
layout.xaxis
Type:
enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position
Parent:
layout.xaxis
Type:
number between or equal to 0 and 1
Default:
0

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".

range
Parent:
layout.xaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
layout.xaxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.

rangeselector
Parent:
layout.xaxis
Type:
object containing one or more of the keys listed below.
Default:
true

Determines whether or not this range selector is visible. Note that range selectors are only available for x axes of `type` set to or auto-typed to "date".

activecolor
Parent:
layout.xaxis.rangeselector
Type:
color

Sets the background color of the active range selector button.

bgcolor
Parent:
layout.xaxis.rangeselector
Type:
color
Default:
"#eee"

Sets the background color of the range selector buttons.

bordercolor
Parent:
layout.xaxis.rangeselector
Type:
color
Default:
"#444"

Sets the color of the border enclosing the range selector.

borderwidth
Parent:
layout.xaxis.rangeselector
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) of the border enclosing the range selector.

buttons
Parent:
layout.xaxis.rangeselector
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this button is visible.

count
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
number greater than or equal to 0
Default:
1

Sets the number of steps to take to update the range. Use with `step` to specify the update interval.

label
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
string

Sets the text label to appear on the button.

name
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
string

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

step
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
enumerated , one of ( "month" | "year" | "day" | "hour" | "minute" | "second" | "all" )
Default:
"month"

The unit of measurement that the `count` value will set the range by.

stepmode
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
enumerated , one of ( "backward" | "todate" )
Default:
"backward"

Sets the range update mode. If "backward", the range update shifts the start of range back "count" times "step" milliseconds. If "todate", the range update shifts the start of range back to the first timestamp from "count" times "step" milliseconds back. For example, with `step` set to "year" and `count` set to "1" the range update shifts the start of the range back to January 01 of the current year. Month and year "todate" are currently available only for the built-in (Gregorian) calendar.

templateitemname
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
string

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

visible
Parent:
layout.xaxis.rangeselector.buttons[]
Type:
boolean
Default:
true

Determines whether or not this button is visible.

font
Parent:
layout.xaxis.rangeselector
Type:
object containing one or more of the keys listed below.

Sets the font of the range selector button text.

color
Parent:
layout.xaxis.rangeselector.font
Type:
color
family
Parent:
layout.xaxis.rangeselector.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.xaxis.rangeselector.font
Type:
number greater than or equal to 1
visible
Parent:
layout.xaxis.rangeselector
Type:
boolean

Determines whether or not this range selector is visible. Note that range selectors are only available for x axes of `type` set to or auto-typed to "date".

x
Parent:
layout.xaxis.rangeselector
Type:
number between or equal to -2 and 3

Sets the x position (in normalized coordinates) of the range selector.

xanchor
Parent:
layout.xaxis.rangeselector
Type:
enumerated , one of ( "auto" | "left" | "center" | "right" )
Default:
"left"

Sets the range selector's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.

y
Parent:
layout.xaxis.rangeselector
Type:
number between or equal to -2 and 3

Sets the y position (in normalized coordinates) of the range selector.

yanchor
Parent:
layout.xaxis.rangeselector
Type:
enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
Default:
"bottom"

Sets the range selector's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.

rangeslider
Parent:
layout.xaxis
Type:
object containing one or more of the keys listed below.
Default:
"#fff"

Sets the background color of the range slider.

autorange
Parent:
layout.xaxis.rangeslider
Type:
boolean
Default:
true

Determines whether or not the range slider range is computed in relation to the input data. If `range` is provided, then `autorange` is set to "false".

bgcolor
Parent:
layout.xaxis.rangeslider
Type:
color
Default:
"#fff"

Sets the background color of the range slider.

bordercolor
Parent:
layout.xaxis.rangeslider
Type:
color
Default:
"#444"

Sets the border color of the range slider.

borderwidth
Parent:
layout.xaxis.rangeslider
Type:
integer greater than or equal to 0
Default:
0

Sets the border width of the range slider.

range
Parent:
layout.xaxis.rangeslider
Type:
array

Sets the range of the range slider. If not set, defaults to the full xaxis range. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

thickness
Parent:
layout.xaxis.rangeslider
Type:
number between or equal to 0 and 1
Default:
0.15

The height of the range slider as a fraction of the total plot area height.

visible
Parent:
layout.xaxis.rangeslider
Type:
boolean
Default:
true

Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to `fixedrange`

yaxis
Parent:
layout.xaxis.rangeslider
Type:
object containing one or more of the keys listed below.
Default:
"match"

Determines whether or not the range of this axis in the rangeslider use the same value than in the main plot when zooming in/out. If "auto", the autorange will be used. If "fixed", the `range` is used. If "match", the current range of the corresponding y-axis on the main subplot is used.

range
Parent:
layout.xaxis.rangeslider.yaxis
Type:
array

Sets the range of this axis for the rangeslider.

rangemode
Parent:
layout.xaxis.rangeslider.yaxis
Type:
enumerated , one of ( "auto" | "fixed" | "match" )
Default:
"match"

Determines whether or not the range of this axis in the rangeslider use the same value than in the main plot when zooming in/out. If "auto", the autorange will be used. If "fixed", the `range` is used. If "match", the current range of the corresponding y-axis on the main subplot is used.

scaleanchor
Parent:
layout.xaxis
Type:
enumerated , one of ( "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden.

scaleratio
Parent:
layout.xaxis
Type:
number greater than or equal to 0
Default:
1

If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands
Parent:
layout.xaxis
Type:
boolean

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

showdividers
Parent:
layout.xaxis
Type:
boolean
Default:
true

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.

showexponent
Parent:
layout.xaxis
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.

showgrid
Parent:
layout.xaxis
Type:
boolean

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.xaxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showspikes
Parent:
layout.xaxis
Type:
boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels
Parent:
layout.xaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.xaxis
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:
layout.xaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

side
Parent:
layout.xaxis
Type:
enumerated , one of ( "top" | "bottom" | "left" | "right" )

Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.

spikecolor
Parent:
layout.xaxis
Type:
color

Sets the spike color. If undefined, will use the series color

spikedash
Parent:
layout.xaxis
Type:
string
Default:
"dash"

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").

spikemode
Parent:
layout.xaxis
Type:
flaglist string. Any combination of "toaxis", "across", "marker" joined with a "+"
Default:
"toaxis"

Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on

spikesnap
Parent:
layout.xaxis
Type:
enumerated , one of ( "data" | "cursor" )
Default:
"data"

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness
Parent:
layout.xaxis
Type:
number
Default:
3

Sets the width (in px) of the zero line.

tick0
Parent:
layout.xaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.xaxis
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:
layout.xaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.xaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.xaxis.tickfont
Type:
color
family
Parent:
layout.xaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.xaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.xaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.xaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.xaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.xaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.xaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.xaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.xaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.xaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.xaxis
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:
layout.xaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.xaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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.

tickson
Parent:
layout.xaxis
Type:
enumerated , one of ( "labels" | "boundaries" )
Default:
"labels"

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix
Parent:
layout.xaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.xaxis
Type:
data array

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

tickvals
Parent:
layout.xaxis
Type:
data array

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

tickwidth
Parent:
layout.xaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.xaxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.xaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.xaxis.title.font
Type:
color
family
Parent:
layout.xaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.xaxis.title.font
Type:
number greater than or equal to 1
standoff
Parent:
layout.xaxis.title
Type:
number greater than or equal to 0

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title `font.size` and the axis `linewidth`. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting `standoff` and turning on `automargin`, plotly.js will push the margins to fit the axis title at given standoff distance.

text
Parent:
layout.xaxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
layout.xaxis
Type:
enumerated , one of ( "-" | "linear" | "log" | "date" | "category" | "multicategory" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

uirevision
Parent:
layout.xaxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.

visible
Parent:
layout.xaxis
Type:
boolean

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

zeroline
Parent:
layout.xaxis
Type:
boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.

zerolinecolor
Parent:
layout.xaxis
Type:
color
Default:
"#444"

Sets the line color of the zero line.

zerolinewidth
Parent:
layout.xaxis
Type:
number
Default:
1

Sets the width (in px) of the zero line.

yaxis
Parent:
layout
Type:
object containing one or more of the keys listed below.
Default:
"#444"

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

anchor
Parent:
layout.yaxis
Type:
enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.

automargin
Parent:
layout.yaxis
Type:
boolean

Determines whether long tick labels automatically grow the figure margins.

autorange
Parent:
layout.yaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

calendar
Parent:
layout.yaxis
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`

categoryarray
Parent:
layout.yaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
layout.yaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

color
Parent:
layout.yaxis
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

constrain
Parent:
layout.yaxis
Type:
enumerated , one of ( "range" | "domain" )
Default:
"range"

If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range" (default), or by decreasing the "domain".

constraintoward
Parent:
layout.yaxis
Type:
enumerated , one of ( "left" | "center" | "right" | "top" | "middle" | "bottom" )

If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.

dividercolor
Parent:
layout.yaxis
Type:
color
Default:
"#444"

Sets the color of the dividers Only has an effect on "multicategory" axes.

dividerwidth
Parent:
layout.yaxis
Type:
number
Default:
1

Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.

domain
Parent:
layout.yaxis
Type:
array
Default:
[0, 1]

Sets the domain of this axis (in plot fraction).

dtick
Parent:
layout.yaxis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
layout.yaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

fixedrange
Parent:
layout.yaxis
Type:
boolean

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

gridcolor
Parent:
layout.yaxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

gridwidth
Parent:
layout.yaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

hoverformat
Parent:
layout.yaxis
Type:
string
Default:
""

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

layer
Parent:
layout.yaxis
Type:
enumerated , one of ( "above traces" | "below traces" )
Default:
"above traces"

Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "false" to show markers and/or text nodes above this axis.

linecolor
Parent:
layout.yaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
layout.yaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

matches
Parent:
layout.yaxis
Type:
enumerated , one of ( "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.

mirror
Parent:
layout.yaxis
Type:
enumerated , one of ( true | "ticks" | false | "all" | "allticks" )

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.

nticks
Parent:
layout.yaxis
Type:
integer greater than or equal to 0
Default:
0

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

overlaying
Parent:
layout.yaxis
Type:
enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position
Parent:
layout.yaxis
Type:
number between or equal to 0 and 1
Default:
0

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".

range
Parent:
layout.yaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
layout.yaxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.

scaleanchor
Parent:
layout.yaxis
Type:
enumerated , one of ( "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )

If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden.

scaleratio
Parent:
layout.yaxis
Type:
number greater than or equal to 0
Default:
1

If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands
Parent:
layout.yaxis
Type:
boolean

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

showdividers
Parent:
layout.yaxis
Type:
boolean
Default:
true

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.

showexponent
Parent:
layout.yaxis
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.

showgrid
Parent:
layout.yaxis
Type:
boolean

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
layout.yaxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showspikes
Parent:
layout.yaxis
Type:
boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels
Parent:
layout.yaxis
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
layout.yaxis
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:
layout.yaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

side
Parent:
layout.yaxis
Type:
enumerated , one of ( "top" | "bottom" | "left" | "right" )

Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.

spikecolor
Parent:
layout.yaxis
Type:
color

Sets the spike color. If undefined, will use the series color

spikedash
Parent:
layout.yaxis
Type:
string
Default:
"dash"

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").

spikemode
Parent:
layout.yaxis
Type:
flaglist string. Any combination of "toaxis", "across", "marker" joined with a "+"
Default:
"toaxis"

Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on

spikesnap
Parent:
layout.yaxis
Type:
enumerated , one of ( "data" | "cursor" )
Default:
"data"

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness
Parent:
layout.yaxis
Type:
number
Default:
3

Sets the width (in px) of the zero line.

tick0
Parent:
layout.yaxis
Type:
number or categorical coordinate string

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

tickangle
Parent:
layout.yaxis
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:
layout.yaxis
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
layout.yaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
layout.yaxis.tickfont
Type:
color
family
Parent:
layout.yaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.yaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
layout.yaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
layout.yaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
layout.yaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
layout.yaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
layout.yaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
layout.yaxis.tickformatstops[]
Type:
string

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

value
Parent:
layout.yaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
layout.yaxis
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
layout.yaxis
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:
layout.yaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
layout.yaxis
Type:
enumerated , one of ( "outside" | "inside" | "" )

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.

tickson
Parent:
layout.yaxis
Type:
enumerated , one of ( "labels" | "boundaries" )
Default:
"labels"

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix
Parent:
layout.yaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
layout.yaxis
Type:
data array

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

tickvals
Parent:
layout.yaxis
Type:
data array

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

tickwidth
Parent:
layout.yaxis
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
layout.yaxis
Type:
object containing one or more of the keys listed below.

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
layout.yaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

color
Parent:
layout.yaxis.title.font
Type:
color
family
Parent:
layout.yaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
layout.yaxis.title.font
Type:
number greater than or equal to 1
standoff
Parent:
layout.yaxis.title
Type:
number greater than or equal to 0

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title `font.size` and the axis `linewidth`. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting `standoff` and turning on `automargin`, plotly.js will push the margins to fit the axis title at given standoff distance.

text
Parent:
layout.yaxis.title
Type:
string

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
layout.yaxis
Type:
enumerated , one of ( "-" | "linear" | "log" | "date" | "category" | "multicategory" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

uirevision
Parent:
layout.yaxis
Type:
number or categorical coordinate string

Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`.

visible
Parent:
layout.yaxis
Type:
boolean

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

zeroline
Parent:
layout.yaxis
Type:
boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.

zerolinecolor
Parent:
layout.yaxis
Type:
color
Default:
"#444"

Sets the line color of the zero line.

zerolinewidth
Parent:
layout.yaxis
Type:
number
Default:
1

Sets the width (in px) of the zero line.

1. Scatter traces

A 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.

cliponaxis
Parent:
data[type=scatter]
Type:
boolean
Default:
true

Determines 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:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scatter]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=scatter]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=scatter]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

error_x
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scatter].error_x
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

copy_ystyle
Parent:
data[type=scatter].error_x
Type:
boolean
symmetric
Parent:
data[type=scatter].error_x
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scatter].error_x
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scatter].error_y
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

symmetric
Parent:
data[type=scatter].error_y
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scatter].error_y
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

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:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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.

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".
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.

hoverlabel
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scatter].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scatter].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoveron
Parent:
data[type=scatter]
Type:
flaglist string. Any combination of "points", "fills" joined with a "+"

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".

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

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.

ids
Parent:
data[type=scatter]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scatter]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scatter].line
Type:
color

Sets 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:
true

Simplifies 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:
1

Has 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:
2

Sets the line width (in px).

marker
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.
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.

autocolorscale
Parent:
data[type=scatter].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scatter].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scatter].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scatter].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=scatter].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scatter].marker.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter].marker.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scatter].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scatter].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scatter].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=scatter].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scatter].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scatter].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=scatter].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scatter].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scatter].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scatter].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scatter].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scatter].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scatter].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scatter].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scatter].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scatter].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scatter].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scatter].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

gradient
Parent:
data[type=scatter].marker
Type:
object containing one or more of the keys listed below.
Default:
"none"

Sets the type of gradient used to fill the markers

color
Parent:
data[type=scatter].marker.gradient
Type:
color or array of colors

Sets 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

line
Parent:
data[type=scatter].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=scatter].marker.line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarker.linecolor. 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:
subplotid

Sets 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:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scatter].marker.line
Type:
boolean

Reverses 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 0

Sets the width (in px) of the lines bounding the marker points.

maxdisplayed
Parent:
data[type=scatter].marker
Type:
number greater than or equal to 0
Default:
0

Sets 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 1

Sets the marker opacity.

reversescale
Parent:
data[type=scatter].marker
Type:
boolean

Reverses 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:
boolean

Determines 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:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scatter].marker
Type:
number greater than or equal to 0
Default:
0

Has 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:
1

Has 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=scatter].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scatter]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scatter]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scatter]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scatter]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

orientation
Parent:
data[type=scatter]
Type:
enumerated , one of ( "v" | "h" )

Only relevant 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`.

selected
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scatter].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scatter].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scatter].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scatter].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scatter].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scatter].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scatter]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scatter]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

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.

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.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter].textfont
Type:
number or array of numbers greater than or equal to 1
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 appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

type
Parent:
data[type=scatter]
Type:
"scatter"
uirevision
Parent:
data[type=scatter]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scatter]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scatter].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatter].unselected.marker
Type:
color

Sets 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 1

Sets 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 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scatter].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatter].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scatter]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=scatter]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=scatter]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=scatter]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=scatter]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=scatter]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=scatter]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=scatter]
Type:
subplotid
Default:
y

Sets 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.

ycalendar
Parent:
data[type=scatter]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

2. Scattergl traces

A 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.

connectgaps
Parent:
data[type=scattergl]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scattergl]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=scattergl]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=scattergl]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

error_x
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scattergl].error_x
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

copy_ystyle
Parent:
data[type=scattergl].error_x
Type:
boolean
symmetric
Parent:
data[type=scattergl].error_x
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scattergl].error_x
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scattergl].error_y
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

symmetric
Parent:
data[type=scattergl].error_y
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scattergl].error_y
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

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:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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".
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.

hoverlabel
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scattergl].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergl].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scattergl].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

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.

ids
Parent:
data[type=scattergl]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scattergl]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scattergl].line
Type:
color

Sets the line color.

dash
Parent:
data[type=scattergl].line
Type:
enumerated , one of ( "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
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:
2

Sets the line width (in px).

marker
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets themarkercolor. 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.

autocolorscale
Parent:
data[type=scattergl].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scattergl].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scattergl].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scattergl].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=scattergl].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scattergl].marker.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergl].marker.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scattergl].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scattergl].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scattergl].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=scattergl].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scattergl].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scattergl].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=scattergl].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scattergl].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scattergl].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergl].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scattergl].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scattergl].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scattergl].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scattergl].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scattergl].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scattergl].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scattergl].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scattergl].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scattergl].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=scattergl].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets themarker.linecolor. 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.

autocolorscale
Parent:
data[type=scattergl].marker.line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarker.linecolor. 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:
subplotid

Sets 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:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scattergl].marker.line
Type:
boolean

Reverses 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 0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=scattergl].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scattergl].marker
Type:
boolean

Reverses 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:
boolean

Determines 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:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scattergl].marker
Type:
number greater than or equal to 0
Default:
0

Has 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:
1

Has 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" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scattergl]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scattergl]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "none".

Determines the drawing mode for this scatter trace.

name
Parent:
data[type=scattergl]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scattergl]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

selected
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scattergl].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scattergl].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scattergl].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scattergl].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scattergl].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scattergl].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scattergl]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scattergl]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergl].textfont
Type:
number or array of numbers greater than or equal to 1
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 appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

type
Parent:
data[type=scattergl]
Type:
"scattergl"
uirevision
Parent:
data[type=scattergl]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scattergl]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scattergl].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattergl].unselected.marker
Type:
color

Sets 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 1

Sets 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 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scattergl].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattergl].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scattergl]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=scattergl]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=scattergl]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=scattergl]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=scattergl]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=scattergl]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=scattergl]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=scattergl]
Type:
subplotid
Default:
y

Sets 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.

ycalendar
Parent:
data[type=scattergl]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

3. Bar traces

A 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 th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.

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.

base
Parent:
data[type=bar]
Type:
number or categorical coordinate string

Sets 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.

cliponaxis
Parent:
data[type=bar]
Type:
boolean
Default:
true

Determines 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.

customdata
Parent:
data[type=bar]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=bar]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=bar]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

error_x
Parent:
data[type=bar]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=bar].error_x
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

copy_ystyle
Parent:
data[type=bar].error_x
Type:
boolean
symmetric
Parent:
data[type=bar].error_x
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=bar].error_x
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y
Parent:
data[type=bar]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=bar].error_y
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

symmetric
Parent:
data[type=bar].error_y
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=bar].error_y
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

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".
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.

hoverlabel
Parent:
data[type=bar]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=bar].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=bar].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=bar].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

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.

ids
Parent:
data[type=bar]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=bar].insidetextfont
Type:
number or array of numbers greater than or equal to 1
legendgroup
Parent:
data[type=bar]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=bar]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=bar].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=bar].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=bar].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=bar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=bar].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=bar].marker.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=bar].marker.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=bar].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=bar].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=bar].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=bar].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=bar].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=bar].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=bar].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=bar].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=bar].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=bar].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=bar].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=bar].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=bar].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=bar].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=bar].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=bar].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=bar].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=bar].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=bar].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=bar].marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=bar].marker.line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarker.linecolor. 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:
subplotid

Sets 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:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=bar].marker.line
Type:
boolean

Reverses 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:
0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=bar].marker
Type:
number or array of numbers between or equal to 0 and 1
Default:
1

Sets the opacity of the bars.

reversescale
Parent:
data[type=bar].marker
Type:
boolean

Reverses 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:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

meta
Parent:
data[type=bar]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=bar]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

offset
Parent:
data[type=bar]
Type:
number or array of numbers

Shifts 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.

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.

opacity
Parent:
data[type=bar]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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).

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=bar].outsidetextfont
Type:
number or array of numbers greater than or equal to 1
selected
Parent:
data[type=bar]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=bar].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=bar].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=bar].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

textfont
Parent:
data[type=bar].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=bar].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=bar]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=bar]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=bar].textfont
Type:
number or array of numbers greater than or equal to 1
textposition
Parent:
data[type=bar]
Type:
enumerated or array of enumerateds , one of ( "inside" | "outside" | "auto" | "none" )
Default:
"none"

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.

texttemplate
Parent:
data[type=bar]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

type
Parent:
data[type=bar]
Type:
"bar"
uirevision
Parent:
data[type=bar]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=bar]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=bar].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=bar].unselected.marker
Type:
color

Sets 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 1

Sets the marker opacity of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=bar].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=bar].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=bar]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width
Parent:
data[type=bar]
Type:
number or array of numbers greater than or equal to 0

Sets the bar width (in position axis units).

x
Parent:
data[type=bar]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=bar]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=bar]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=bar]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=bar]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=bar]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=bar]
Type:
subplotid
Default:
y

Sets 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.

ycalendar
Parent:
data[type=bar]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

4. Pie traces

A 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`

automargin
Parent:
data[type=pie]
Type:
boolean

Determines whether outside text labels can push the margins.

customdata
Parent:
data[type=pie]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

direction
Parent:
data[type=pie]
Type:
enumerated , one of ( "clockwise" | "counterclockwise" )
Default:
"counterclockwise"

Specifies the direction at which succeeding sectors follow one another.

dlabel
Parent:
data[type=pie]
Type:
number
Default:
1

Sets the label step. See `label0` for more info.

domain
Parent:
data[type=pie]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this pie trace (in plot fraction).

column
Parent:
data[type=pie].domain
Type:
integer greater than or equal to 0
Default:
0

If 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:
0

If 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).

hole
Parent:
data[type=pie]
Type:
number between or equal to 0 and 1
Default:
0

Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

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".
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.

hoverlabel
Parent:
data[type=pie]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=pie].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=pie].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=pie].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

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.

ids
Parent:
data[type=pie]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=pie].insidetextfont
Type:
number or array of numbers greater than or equal to 1
label0
Parent:
data[type=pie]
Type:
number
Default:
0

Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.

labels
Parent:
data[type=pie]
Type:
data array

Sets 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.

legendgroup
Parent:
data[type=pie]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=pie]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

colors
Parent:
data[type=pie].marker
Type:
data array

Sets 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.
Default:
"#444"

Sets the color of the line enclosing each sector.

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:
0

Sets the width (in px) of the line enclosing each sector.

meta
Parent:
data[type=pie]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=pie]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=pie]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=pie].outsidetextfont
Type:
number or array of numbers greater than or equal to 1
pull
Parent:
data[type=pie]
Type:
number or array of numbers between or equal to 0 and 1
Default:
0

Sets 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.

rotation
Parent:
data[type=pie]
Type:
number between or equal to -360 and 360
Default:
0

Instead 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.

showlegend
Parent:
data[type=pie]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

sort
Parent:
data[type=pie]
Type:
boolean
Default:
true

Determines whether or not the sectors are reordered from largest to smallest.

text
Parent:
data[type=pie]
Type:
data array

Sets 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.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=pie].textfont
Type:
number or array of numbers greater than or equal to 1
textinfo
Parent:
data[type=pie]
Type:
flaglist string. Any combination of "label", "text", "value", "percent" joined with a "+" OR "none".

Determines which trace information appear on the graph.

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 appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `percent` and `text`.

title
Parent:
data[type=pie]
Type:
object containing one or more of the keys listed below.
Default:
""

Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=pie].title
Type:
object containing one or more of the keys listed below.

Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=pie].title.font
Type:
number or array of numbers greater than or equal to 1
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`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.

text
Parent:
data[type=pie].title
Type:
string
Default:
""

Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
data[type=pie]
Type:
"pie"
uirevision
Parent:
data[type=pie]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

values
Parent:
data[type=pie]
Type:
data array

Sets the values of the sectors. If omitted, we count occurrences of each label.

visible
Parent:
data[type=pie]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

5. Heatmap traces

A 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.

autocolorscale
Parent:
data[type=heatmap]
Type:
boolean

Determines 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.

coloraxis
Parent:
data[type=heatmap]
Type:
subplotid

Sets 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=heatmap]
Type:
object containing one or more of the keys listed below.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=heatmap].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=heatmap].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=heatmap].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=heatmap].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=heatmap].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=heatmap].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=heatmap].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=heatmap].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=heatmap].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=heatmap].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=heatmap].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=heatmap].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=heatmap].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=heatmap].colorbar.title.font
Type:
color
family
Parent:
data[type=heatmap].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=heatmap].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=heatmap].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=heatmap].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=heatmap].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=heatmap].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=heatmap].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=heatmap].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=heatmap].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=heatmap].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=heatmap]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

connectgaps
Parent:
data[type=heatmap]
Type:
boolean

Determines 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.

customdata
Parent:
data[type=heatmap]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=heatmap]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=heatmap]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

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".
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.

hoverlabel
Parent:
data[type=heatmap]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=heatmap].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=heatmap].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=heatmap].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoverongaps
Parent:
data[type=heatmap]
Type:
boolean
Default:
true

Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=heatmap]
Type:
data array

Same as `text`.

ids
Parent:
data[type=heatmap]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

meta
Parent:
data[type=heatmap]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=heatmap]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=heatmap]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

reversescale
Parent:
data[type=heatmap]
Type:
boolean

Reverses 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.

showscale
Parent:
data[type=heatmap]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

text
Parent:
data[type=heatmap]
Type:
data array

Sets the text elements associated with each z value.

transpose
Parent:
data[type=heatmap]
Type:
boolean

Transposes the z data.

type
Parent:
data[type=heatmap]
Type:
"heatmap"
uirevision
Parent:
data[type=heatmap]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=heatmap]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=heatmap]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=heatmap]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=heatmap]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=heatmap]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

xgap
Parent:
data[type=heatmap]
Type:
number greater than or equal to 0
Default:
0

Sets the horizontal gap (in pixels) between bricks.

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).

y
Parent:
data[type=heatmap]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=heatmap]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=heatmap]
Type:
subplotid
Default:
y

Sets 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.

ycalendar
Parent:
data[type=heatmap]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

ygap
Parent:
data[type=heatmap]
Type:
number greater than or equal to 0
Default:
0

Sets the vertical gap (in pixels) between bricks.

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)

z
Parent:
data[type=heatmap]
Type:
data array

Sets the z data.

zauto
Parent:
data[type=heatmap]
Type:
boolean
Default:
true

Determines 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 rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

zmax
Parent:
data[type=heatmap]
Type:
number

Sets 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:
number

Sets 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:
number

Sets 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.

6. Heatmapgl traces

A heatmapgl trace is an object with the key "type" equal to "heatmapgl" (i.e. {"type": "heatmapgl"}) and any of the keys listed below. WebGL version of the heatmap trace type.

autocolorscale
Parent:
data[type=heatmapgl]
Type:
boolean

Determines 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.

coloraxis
Parent:
data[type=heatmapgl]
Type:
subplotid

Sets 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=heatmapgl]
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=heatmapgl].colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=heatmapgl].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=heatmapgl].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=heatmapgl].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=heatmapgl].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.

nticks
Parent:
data[type=heatmapgl].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=heatmapgl].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=heatmapgl].colorbar
Type:
boolean

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

showexponent
Parent:
data[type=heatmapgl].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=heatmapgl].colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=heatmapgl].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=heatmapgl].colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=heatmapgl].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=heatmapgl].colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=heatmapgl].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=heatmapgl].colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=heatmapgl].colorbar
Type:
object containing one or more of the keys listed below.

Sets the color bar's tick label font

color
Parent:
data[type=heatmapgl].colorbar.tickfont
Type:
color
family
Parent:
data[type=heatmapgl].colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=heatmapgl].colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=heatmapgl].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=heatmapgl].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=heatmapgl].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=heatmapgl].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=heatmapgl].colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=heatmapgl].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=heatmapgl].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=heatmapgl].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=heatmapgl].colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=heatmapgl].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=heatmapgl].colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=heatmapgl].colorbar
Type:
data array

Sets 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=heatmapgl].colorbar
Type:
data array

Sets 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=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=heatmapgl].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=heatmapgl].colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=heatmapgl].colorbar.title.font
Type:
color
family
Parent:
data[type=heatmapgl].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=heatmapgl].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=heatmapgl].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=heatmapgl].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=heatmapgl].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=heatmapgl].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=heatmapgl].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=heatmapgl].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=heatmapgl].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=heatmapgl]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=heatmapgl]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=heatmapgl]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=heatmapgl]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

hoverinfo
Parent:
data[type=heatmapgl]
Type:
flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=heatmapgl]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=heatmapgl].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=heatmapgl].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=heatmapgl].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=heatmapgl].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=heatmapgl].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=heatmapgl].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=heatmapgl].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=heatmapgl].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

ids
Parent:
data[type=heatmapgl]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

meta
Parent:
data[type=heatmapgl]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=heatmapgl]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=heatmapgl]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

reversescale
Parent:
data[type=heatmapgl]
Type:
boolean

Reverses 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.

showscale
Parent:
data[type=heatmapgl]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

text
Parent:
data[type=heatmapgl]
Type:
data array

Sets the text elements associated with each z value.

transpose
Parent:
data[type=heatmapgl]
Type:
boolean

Transposes the z data.

type
Parent:
data[type=heatmapgl]
Type:
"heatmapgl"
uirevision
Parent:
data[type=heatmapgl]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=heatmapgl]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=heatmapgl]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=heatmapgl]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=heatmapgl]
Type:
subplotid
Default:
x

Sets 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.

xtype
Parent:
data[type=heatmapgl]
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=heatmapgl]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=heatmapgl]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=heatmapgl]
Type:
subplotid
Default:
y

Sets 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.

ytype
Parent:
data[type=heatmapgl]
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=heatmapgl]
Type:
data array

Sets the z data.

zauto
Parent:
data[type=heatmapgl]
Type:
boolean
Default:
true

Determines 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.

zmax
Parent:
data[type=heatmapgl]
Type:
number

Sets 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=heatmapgl]
Type:
number

Sets 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=heatmapgl]
Type:
number

Sets 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.

7. Image traces

A 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.

colormodel
Parent:
data[type=image]
Type:
enumerated , one of ( "rgb" | "rgba" | "hsl" | "hsla" )
Default:
"rgb"

Color model used to map the numerical color components described in `z` into colors.

customdata
Parent:
data[type=image]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=image]
Type:
number
Default:
1

Set the pixel's horizontal size.

dy
Parent:
data[type=image]
Type:
number
Default:
1

Set the pixel's vertical size

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".
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.

hoverlabel
Parent:
data[type=image]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=image].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=image].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=image].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

hovertext
Parent:
data[type=image]
Type:
data array

Same as `text`.

ids
Parent:
data[type=image]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

meta
Parent:
data[type=image]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=image]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=image]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

text
Parent:
data[type=image]
Type:
data array

Sets the text elements associated with each z value.

type
Parent:
data[type=image]
Type:
"image"
uirevision
Parent:
data[type=image]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=image]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x0
Parent:
data[type=image]
Type:
number or categorical coordinate string
Default:
0

Set the image's x position.

xaxis
Parent:
data[type=image]
Type:
subplotid
Default:
x

Sets 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.

y0
Parent:
data[type=image]
Type:
number or categorical coordinate string
Default:
0

Set the image's y position.

yaxis
Parent:
data[type=image]
Type:
subplotid
Default:
y

Sets 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.

z
Parent:
data[type=image]
Type:
data array

A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

zmax
Parent:
data[type=image]
Type:
array

Array 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 `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1].

zmin
Parent:
data[type=image]
Type:
array

Array 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 `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0].

8. Contour traces

A 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.

autocolorscale
Parent:
data[type=contour]
Type:
boolean

Determines 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.

autocontour
Parent:
data[type=contour]
Type:
boolean
Default:
true

Determines 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`.

coloraxis
Parent:
data[type=contour]
Type:
subplotid

Sets 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=contour]
Type:
object containing one or more of the keys listed below.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=contour].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=contour].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=contour].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=contour].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=contour].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contour].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=contour].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=contour].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=contour].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=contour].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=contour].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=contour].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=contour].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=contour].colorbar.title.font
Type:
color
family
Parent:
data[type=contour].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contour].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=contour].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=contour].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=contour].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=contour].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=contour].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=contour].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=contour].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=contour].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=contour]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

connectgaps
Parent:
data[type=contour]
Type:
boolean

Determines 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.
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.

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:
number

Sets 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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contour].contours.labelfont
Type:
number greater than or equal to 1
labelformat
Parent:
data[type=contour].contours
Type:
string
Default:
""

Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

operation
Parent:
data[type=contour].contours
Type:
enumerated , one of ( "=" | "&lt;" | "&gt;=" | "&gt;" | "&lt;=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
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:
boolean

Determines whether to label the contour lines with their values.

showlines
Parent:
data[type=contour].contours
Type:
boolean
Default:
true

Determines 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 0

Sets the step between each contour level. Must be positive.

start
Parent:
data[type=contour].contours
Type:
number

Sets 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:
0

Sets 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.

customdata
Parent:
data[type=contour]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=contour]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=contour]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

fillcolor
Parent:
data[type=contour]
Type:
color

Sets 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.

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".
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.

hoverlabel
Parent:
data[type=contour]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=contour].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contour].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=contour].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoverongaps
Parent:
data[type=contour]
Type:
boolean
Default:
true

Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=contour]
Type:
data array

Same as `text`.

ids
Parent:
data[type=contour]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=contour]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=contour]
Type:
object containing one or more of the keys listed below.
Default:
"solid"

Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".

color
Parent:
data[type=contour].line
Type:
color

Sets 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:
1

Sets 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 0

Sets the contour line width in (in px) Defaults to "0.5" when `contours.type` is "levels". Defaults to "2" when `contour.type` is "constraint".

meta
Parent:
data[type=contour]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=contour]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

ncontours
Parent:
data[type=contour]
Type:
integer greater than or equal to 1
Default:
15

Sets 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.

opacity
Parent:
data[type=contour]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

reversescale
Parent:
data[type=contour]
Type:
boolean

Reverses 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.

showlegend
Parent:
data[type=contour]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale
Parent:
data[type=contour]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

text
Parent:
data[type=contour]
Type:
data array

Sets the text elements associated with each z value.

transpose
Parent:
data[type=contour]
Type:
boolean

Transposes the z data.

type
Parent:
data[type=contour]
Type:
"contour"
uirevision
Parent:
data[type=contour]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=contour]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=contour]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=contour]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=contour]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=contour]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

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 array

Sets the y coordinates.

y0
Parent:
data[type=contour]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=contour]
Type:
subplotid
Default:
y

Sets 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.

ycalendar
Parent:
data[type=contour]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

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 array

Sets the z data.

zauto
Parent:
data[type=contour]
Type:
boolean
Default:
true

Determines 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 rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

zmax
Parent:
data[type=contour]
Type:
number

Sets 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:
number

Sets 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:
number

Sets 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.

9. Table traces

A 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.

cells
Parent:
data[type=table]
Type:
object containing one or more of the keys listed below.

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
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 more 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.
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
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.

font
Parent:
data[type=table].cells
Type:
object containing one or more of the keys listed below.

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=table].cells.font
Type:
number or array of numbers greater than or equal to 1
format
Parent:
data[type=table].cells
Type:
data array

Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

height
Parent:
data[type=table].cells
Type:
number
Default:
20

The height of cells.

line
Parent:
data[type=table].cells
Type:
object containing one or more of the keys listed below.
Default:
1
color
Parent:
data[type=table].cells.line
Type:
color or array of colors
Default:
"grey"
width
Parent:
data[type=table].cells.line
Type:
number or array of numbers
Default:
1
prefix
Parent:
data[type=table].cells
Type:
string or array of strings

Prefix for cell values.

suffix
Parent:
data[type=table].cells
Type:
string or array of strings

Suffix for cell values.

values
Parent:
data[type=table].cells
Type:
data array

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.

columnorder
Parent:
data[type=table]
Type:
data array

Specifies 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 numbers

The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

customdata
Parent:
data[type=table]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

domain
Parent:
data[type=table]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this table trace (in plot fraction).

column
Parent:
data[type=table].domain
Type:
integer greater than or equal to 0
Default:
0

If 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:
0

If 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).

header
Parent:
data[type=table]
Type:
object containing one or more of the keys listed below.

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
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 more 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.
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
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.

font
Parent:
data[type=table].header
Type:
object containing one or more of the keys listed below.

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=table].header.font
Type:
number or array of numbers greater than or equal to 1
format
Parent:
data[type=table].header
Type:
data array

Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

height
Parent:
data[type=table].header
Type:
number
Default:
28

The height of cells.

line
Parent:
data[type=table].header
Type:
object containing one or more of the keys listed below.
Default:
1
color
Parent:
data[type=table].header.line
Type:
color or array of colors
Default:
"grey"
width
Parent:
data[type=table].header.line
Type:
number or array of numbers
Default:
1
prefix
Parent:
data[type=table].header
Type:
string or array of strings

Prefix for cell values.

suffix
Parent:
data[type=table].header
Type:
string or array of strings

Suffix for cell values.

values
Parent:
data[type=table].header
Type:
data array

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.

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".
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.

hoverlabel
Parent:
data[type=table]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=table].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=table].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=table].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

ids
Parent:
data[type=table]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

meta
Parent:
data[type=table]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=table]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

type
Parent:
data[type=table]
Type:
"table"
uirevision
Parent:
data[type=table]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=table]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

10. Box traces

A box trace is an object with the key "type" equal to "box" (i.e. {"type": "box"}) and any of the keys listed below. In vertical (horizontal) box plots, statistics are computed using `y` (`x`) values. 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. That box position is then positioned with with `name` or with `x0` (`y0`) if provided. Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2) is marked by a line inside the box. By default, the whiskers correspond to the box' edges +/- 1.5 times the interquartile range (IQR: Q3-Q1), see "boxpoints" for other options.

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.

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.

boxpoints
Parent:
data[type=box]
Type:
enumerated , one of ( "all" | "outliers" | "suspectedoutliers" | false )
Default:
"outliers"

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

customdata
Parent:
data[type=box]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

fillcolor
Parent:
data[type=box]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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".
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.

hoverlabel
Parent:
data[type=box]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=box].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=box].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=box].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoveron
Parent:
data[type=box]
Type:
flaglist string. Any combination of "boxes", "points" joined with a "+"
Default:
"boxes+points"

Do the hover effects highlight individual boxes or sample points or both?

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=box]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=box]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

jitter
Parent:
data[type=box]
Type:
number between or equal to 0 and 1

Sets 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).

legendgroup
Parent:
data[type=box]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=box]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the color of line bounding the box(es).

color
Parent:
data[type=box].line
Type:
color

Sets the color of line bounding the box(es).

width
Parent:
data[type=box].line
Type:
number greater than or equal to 0
Default:
2

Sets the width (in px) of line bounding the box(es).

marker
Parent:
data[type=box]
Type:
object containing one or more of the keys listed below.
Default:
"rgba(0, 0, 0, 0)"

Sets the color of the outlier sample points.

color
Parent:
data[type=box].marker
Type:
color

Sets themarkercolor. 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.
Default:
"#444"

Sets themarker.linecolor. 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.

color
Parent:
data[type=box].marker.line
Type:
color
Default:
"#444"

Sets themarker.linecolor. 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:
color

Sets 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:
1

Sets 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:
0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=box].marker
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
6

Sets the marker size (in px).

symbol
Parent:
data[type=box].marker
Type:
enumerated , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=box]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=box]
Type:
string

Sets the trace name. The trace name appear 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

notched
Parent:
data[type=box]
Type:
boolean

Determines whether or not notches should be drawn.

notchwidth
Parent:
data[type=box]
Type:
number between or equal to 0 and 0.5
Default:
0.25

Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).

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.

opacity
Parent:
data[type=box]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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).

pointpos
Parent:
data[type=box]
Type:
number between or equal to -2 and 2

Sets 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

selected
Parent:
data[type=box]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=box].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=box].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=box].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=box].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

selectedpoints
Parent:
data[type=box]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=box]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

type
Parent:
data[type=box]
Type:
"box"
uirevision
Parent:
data[type=box]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=box]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=box].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=box].unselected.marker
Type:
color

Sets 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 1

Sets 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 0

Sets the marker size of unselected points, applied only when a selection exists.

visible
Parent:
data[type=box]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

whiskerwidth
Parent:
data[type=box]
Type:
number between or equal to 0 and 1
Default:
0.5

Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

width
Parent:
data[type=box]
Type:
number greater than or equal to 0
Default:
0

Sets 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.

x
Parent:
data[type=box]
Type:
data array

Sets the x sample data or coordinates. See overview for more info.

x0
Parent:
data[type=box]
Type:
number or categorical coordinate string

Sets the x coordinate of the box. See overview for more info.

xaxis
Parent:
data[type=box]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=box]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=box]
Type:
data array

Sets the y sample data or coordinates. See overview for more info.

y0
Parent:
data[type=box]
Type:
number or categorical coordinate string

Sets the y coordinate of the box. See overview for more info.

yaxis
Parent:
data[type=box]
Type:
subplotid
Default:
y

Sets 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.

ycalendar
Parent:
data[type=box]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

11. Violin traces

A 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.

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.

bandwidth
Parent:
data[type=violin]
Type:
number greater than or equal to 0

Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.

box
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.
Default:
0.25

Determines if an miniature box plot is drawn inside the violins.

fillcolor
Parent:
data[type=violin].box
Type:
color

Sets the inner box plot fill color.

line
Parent:
data[type=violin].box
Type:
object containing one or more of the keys listed below.

Sets the inner box plot bounding line color.

color
Parent:
data[type=violin].box.line
Type:
color

Sets the inner box plot bounding line color.

width
Parent:
data[type=violin].box.line
Type:
number greater than or equal to 0

Sets the inner box plot bounding line width.

visible
Parent:
data[type=violin].box
Type:
boolean

Determines 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.25

Sets 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.

customdata
Parent:
data[type=violin]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

fillcolor
Parent:
data[type=violin]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

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".
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.

hoverlabel
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=violin].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=violin].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=violin].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoveron
Parent:
data[type=violin]
Type:
flaglist string. Any combination of "violins", "points", "kde" joined with a "+" OR "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?

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=violin]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=violin]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

jitter
Parent:
data[type=violin]
Type:
number between or equal to 0 and 1

Sets 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.

legendgroup
Parent:
data[type=violin]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the color of line bounding the violin(s).

color
Parent:
data[type=violin].line
Type:
color

Sets the color of line bounding the violin(s).

width
Parent:
data[type=violin].line
Type:
number greater than or equal to 0
Default:
2

Sets the width (in px) of line bounding the violin(s).

marker
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.
Default:
"rgba(0, 0, 0, 0)"

Sets the color of the outlier sample points.

color
Parent:
data[type=violin].marker
Type:
color

Sets themarkercolor. 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.
Default:
"#444"

Sets themarker.linecolor. 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.

color
Parent:
data[type=violin].marker.line
Type:
color
Default:
"#444"

Sets themarker.linecolor. 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:
color

Sets 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:
1

Sets 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:
0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=violin].marker
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
6

Sets the marker size (in px).

symbol
Parent:
data[type=violin].marker
Type:
enumerated , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meanline
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.

Determines 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.

color
Parent:
data[type=violin].meanline
Type:
color

Sets the mean line color.

visible
Parent:
data[type=violin].meanline
Type:
boolean

Determines 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 0

Sets the mean line width.

meta
Parent:
data[type=violin]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=violin]
Type:
string

Sets the trace name. The trace name appear 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).

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.

opacity
Parent:
data[type=violin]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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).

pointpos
Parent:
data[type=violin]
Type:
number between or equal to -2 and 2

Sets 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.

points
Parent:
data[type=violin]
Type:
enumerated , one of ( "all" | "outliers" | "suspectedoutliers" | false )
Default:
"outliers"

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

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 makingup each violin.

selected
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=violin].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=violin].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=violin].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=violin].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

selectedpoints
Parent:
data[type=violin]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=violin]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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:
array

Sets 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.

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.

type
Parent:
data[type=violin]
Type:
"violin"
uirevision
Parent:
data[type=violin]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=violin]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=violin].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=violin].unselected.marker
Type:
color

Sets 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 1

Sets 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 0

Sets the marker size of unselected points, applied only when a selection exists.

visible
Parent:
data[type=violin]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width
Parent:
data[type=violin]
Type:
number greater than or equal to 0
Default:
0

Sets 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.

x
Parent:
data[type=violin]
Type:
data array

Sets the x sample data or coordinates. See overview for more info.

x0
Parent:
data[type=violin]
Type:
number or categorical coordinate string

Sets the x coordinate of the box. See overview for more info.

xaxis
Parent:
data[type=violin]
Type:
subplotid
Default:
x

Sets 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.

y
Parent:
data[type=violin]
Type:
data array

Sets the y sample data or coordinates. See overview for more info.

y0
Parent:
data[type=violin]
Type:
number or categorical coordinate string

Sets the y coordinate of the box. See overview for more info.

yaxis
Parent:
data[type=violin]
Type:
subplotid
Default:
y

Sets 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.

12. Histogram traces

A 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.

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.

autobinx
Parent:
data[type=histogram]
Type:
boolean

Obsolete: 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:
boolean

Obsolete: 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`

cumulative
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.
Default:
"increasing"

If 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
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:
boolean

If 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.

customdata
Parent:
data[type=histogram]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

error_x
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=histogram].error_x
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

copy_ystyle
Parent:
data[type=histogram].error_x
Type:
boolean
symmetric
Parent:
data[type=histogram].error_x
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=histogram].error_x
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=histogram].error_y
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

symmetric
Parent:
data[type=histogram].error_y
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=histogram].error_y
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

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).

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".
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.

hoverlabel
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=histogram].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=histogram].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

hovertext
Parent:
data[type=histogram]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=histogram]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=histogram]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=histogram].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=histogram].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=histogram].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=histogram].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=histogram].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=histogram].marker.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram].marker.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=histogram].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=histogram].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=histogram].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=histogram].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=histogram].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=histogram].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=histogram].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=histogram].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=histogram].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=histogram].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=histogram].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=histogram].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=histogram].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=histogram].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=histogram].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=histogram].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=histogram].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=histogram].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=histogram].marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=histogram].marker.line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarker.linecolor. 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:
subplotid

Sets 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:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=histogram].marker.line
Type:
boolean

Reverses 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:
0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=histogram].marker
Type:
number or array of numbers between or equal to 0 and 1
Default:
1

Sets the opacity of the bars.

reversescale
Parent:
data[type=histogram].marker
Type:
boolean

Reverses 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:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

meta
Parent:
data[type=histogram]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=histogram]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

nbinsx
Parent:
data[type=histogram]
Type:
integer greater than or equal to 0
Default:
0

Specifies 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:
0

Specifies 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.

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.

opacity
Parent:
data[type=histogram]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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).

selected
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=histogram].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=histogram].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=histogram].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

textfont
Parent:
data[type=histogram].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=histogram].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=histogram]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=histogram]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

type
Parent:
data[type=histogram]
Type:
"histogram"
uirevision
Parent:
data[type=histogram]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=histogram].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=histogram].unselected.marker
Type:
color

Sets 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 1

Sets the marker opacity of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=histogram].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=histogram].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=histogram]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=histogram]
Type:
data array

Sets the sample data to be binned on the x axis.

xaxis
Parent:
data[type=histogram]
Type:
subplotid
Default:
x

Sets 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.

xbins
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.

Sets 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
Parent:
data[type=histogram].xbins
Type:
number or categorical coordinate string

Sets 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 string

Sets 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 string

Sets 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.

xcalendar
Parent:
data[type=histogram]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=histogram]
Type:
data array

Sets the sample data to be binned on the y axis.

yaxis
Parent:
data[type=histogram]
Type:
subplotid
Default:
y

Sets 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.

ybins
Parent:
data[type=histogram]
Type:
object containing one or more of the keys listed below.

Sets 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
Parent:
data[type=histogram].ybins
Type:
number or categorical coordinate string

Sets 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 string

Sets 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 string

Sets 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.

ycalendar
Parent:
data[type=histogram]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

13. Histogram2d traces

A 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.

autobinx
Parent:
data[type=histogram2d]
Type:
boolean

Obsolete: 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:
boolean

Obsolete: 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.

autocolorscale
Parent:
data[type=histogram2d]
Type:
boolean

Determines 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.

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.

coloraxis
Parent:
data[type=histogram2d]
Type:
subplotid

Sets 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=histogram2d]
Type:
object containing one or more of the keys listed below.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=histogram2d].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=histogram2d].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=histogram2d].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=histogram2d].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=histogram2d].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2d].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=histogram2d].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=histogram2d].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=histogram2d].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=histogram2d].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=histogram2d].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=histogram2d].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=histogram2d].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=histogram2d].colorbar.title.font
Type:
color
family
Parent:
data[type=histogram2d].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2d].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=histogram2d].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=histogram2d].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=histogram2d].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=histogram2d].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=histogram2d].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=histogram2d].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=histogram2d].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=histogram2d].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=histogram2d]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=histogram2d]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

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).

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".
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.

hoverlabel
Parent:
data[type=histogram2d]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=histogram2d].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2d].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=histogram2d].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

ids
Parent:
data[type=histogram2d]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

marker
Parent:
data[type=histogram2d]
Type:
object containing one or more of the keys listed below.

Sets the aggregation data.

color
Parent:
data[type=histogram2d].marker
Type:
data array

Sets the aggregation data.

meta
Parent:
data[type=histogram2d]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=histogram2d]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

nbinsx
Parent:
data[type=histogram2d]
Type:
integer greater than or equal to 0
Default:
0

Specifies 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:
0

Specifies 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.

opacity
Parent:
data[type=histogram2d]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

reversescale
Parent:
data[type=histogram2d]
Type:
boolean

Reverses 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.

showscale
Parent:
data[type=histogram2d]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

type
Parent:
data[type=histogram2d]
Type:
"histogram2d"
uirevision
Parent:
data[type=histogram2d]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=histogram2d]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=histogram2d]
Type:
data array

Sets the sample data to be binned on the x axis.

xaxis
Parent:
data[type=histogram2d]
Type:
subplotid
Default:
x

Sets 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.

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.

Sets 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
Parent:
data[type=histogram2d].xbins
Type:
number or categorical coordinate string

Sets 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 string

Sets 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 string

Sets 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.

xcalendar
Parent:
data[type=histogram2d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

xgap
Parent:
data[type=histogram2d]
Type:
number greater than or equal to 0
Default:
0

Sets the horizontal gap (in pixels) between bricks.

y
Parent:
data[type=histogram2d]
Type:
data array

Sets the sample data to be binned on the y axis.

yaxis
Parent:
data[type=histogram2d]
Type:
subplotid
Default:
y

Sets 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.

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.

Sets 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
Parent:
data[type=histogram2d].ybins
Type:
number or categorical coordinate string

Sets 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 string

Sets 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 string

Sets 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.

ycalendar
Parent:
data[type=histogram2d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

ygap
Parent:
data[type=histogram2d]
Type:
number greater than or equal to 0
Default:
0

Sets the vertical gap (in pixels) between bricks.

z
Parent:
data[type=histogram2d]
Type:
data array

Sets the aggregation data.

zauto
Parent:
data[type=histogram2d]
Type:
boolean
Default:
true

Determines 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 rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

zmax
Parent:
data[type=histogram2d]
Type:
number

Sets 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:
number

Sets 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:
number

Sets 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.

14. Histogram2dcontour traces

A 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.

autobinx
Parent:
data[type=histogram2dcontour]
Type:
boolean

Obsolete: 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:
boolean

Obsolete: 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.

autocolorscale
Parent:
data[type=histogram2dcontour]
Type:
boolean
Default:
true

Determines 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.

autocontour
Parent:
data[type=histogram2dcontour]
Type:
boolean
Default:
true

Determines 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`.

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.

coloraxis
Parent:
data[type=histogram2dcontour]
Type:
subplotid

Sets 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=histogram2dcontour]
Type:
object containing one or more of the keys listed below.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=histogram2dcontour].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=histogram2dcontour].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=histogram2dcontour].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=histogram2dcontour].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=histogram2dcontour].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2dcontour].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=histogram2dcontour].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=histogram2dcontour].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=histogram2dcontour].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=histogram2dcontour].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=histogram2dcontour].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=histogram2dcontour].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=histogram2dcontour].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=histogram2dcontour].colorbar.title.font
Type:
color
family
Parent:
data[type=histogram2dcontour].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2dcontour].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=histogram2dcontour].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=histogram2dcontour].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=histogram2dcontour].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=histogram2dcontour].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=histogram2dcontour].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=histogram2dcontour].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=histogram2dcontour].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=histogram2dcontour].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=histogram2dcontour]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

contours
Parent:
data[type=histogram2dcontour]
Type:
object containing one or more of the keys listed below.
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.

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:
number

Sets 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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2dcontour].contours.labelfont
Type:
number greater than or equal to 1
labelformat
Parent:
data[type=histogram2dcontour].contours
Type:
string
Default:
""

Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

operation
Parent:
data[type=histogram2dcontour].contours
Type:
enumerated , one of ( "=" | "&lt;" | "&gt;=" | "&gt;" | "&lt;=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
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:
boolean

Determines whether to label the contour lines with their values.

showlines
Parent:
data[type=histogram2dcontour].contours
Type:
boolean
Default:
true

Determines 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 0

Sets the step between each contour level. Must be positive.

start
Parent:
data[type=histogram2dcontour].contours
Type:
number

Sets 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:
0

Sets 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.

customdata
Parent:
data[type=histogram2dcontour]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

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).

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".
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.

hoverlabel
Parent:
data[type=histogram2dcontour]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=histogram2dcontour].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=histogram2dcontour].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=histogram2dcontour].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

ids
Parent:
data[type=histogram2dcontour]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=histogram2dcontour]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=histogram2dcontour]
Type:
object containing one or more of the keys listed below.
Default:
0.5

Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".

color
Parent:
data[type=histogram2dcontour].line
Type:
color

Sets 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:
1

Sets 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.5

Sets the contour line width in (in px)

marker
Parent:
data[type=histogram2dcontour]
Type:
object containing one or more of the keys listed below.

Sets the aggregation data.

color
Parent:
data[type=histogram2dcontour].marker
Type:
data array

Sets the aggregation data.

meta
Parent:
data[type=histogram2dcontour]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=histogram2dcontour]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

nbinsx
Parent:
data[type=histogram2dcontour]
Type:
integer greater than or equal to 0
Default:
0

Specifies 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:
0

Specifies 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.

ncontours
Parent:
data[type=histogram2dcontour]
Type:
integer greater than or equal to 1
Default:
15

Sets 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.

opacity
Parent:
data[type=histogram2dcontour]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

reversescale
Parent:
data[type=histogram2dcontour]
Type:
boolean

Reverses 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.

showlegend
Parent:
data[type=histogram2dcontour]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale
Parent:
data[type=histogram2dcontour]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

type
Parent:
data[type=histogram2dcontour]
Type:
"histogram2dcontour"
uirevision
Parent:
data[type=histogram2dcontour]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=histogram2dcontour]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=histogram2dcontour]
Type:
data array

Sets the sample data to be binned on the x axis.

xaxis
Parent:
data[type=histogram2dcontour]
Type:
subplotid
Default:
x

Sets 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.

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.

Sets 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
Parent:
data[type=histogram2dcontour].xbins
Type:
number or categorical coordinate string

Sets 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 string

Sets 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 string

Sets 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.

xcalendar
Parent:
data[type=histogram2dcontour]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=histogram2dcontour]
Type:
data array

Sets the sample data to be binned on the y axis.

yaxis
Parent:
data[type=histogram2dcontour]
Type:
subplotid
Default:
y

Sets 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.

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.

Sets 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
Parent:
data[type=histogram2dcontour].ybins
Type:
number or categorical coordinate string

Sets 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 string

Sets 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 string

Sets 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.

ycalendar
Parent:
data[type=histogram2dcontour]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

z
Parent:
data[type=histogram2dcontour]
Type:
data array

Sets the aggregation data.

zauto
Parent:
data[type=histogram2dcontour]
Type:
boolean
Default:
true

Determines 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 rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

zmax
Parent:
data[type=histogram2dcontour]
Type:
number

Sets 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:
number

Sets 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:
number

Sets 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.

15. Ohlc traces

A 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.

close
Parent:
data[type=ohlc]
Type:
data array

Sets the close values.

customdata
Parent:
data[type=ohlc]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

decreasing
Parent:
data[type=ohlc]
Type:
object containing one or more of the keys listed below.
Default:
"#FF4136"

Sets the line color.

line
Parent:
data[type=ohlc].decreasing
Type:
object containing one or more of the keys listed below.
Default:
"#FF4136"

Sets the line color.

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:
2

Sets the line width (in px).

high
Parent:
data[type=ohlc]
Type:
data array

Sets the high values.

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".
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.

hoverlabel
Parent:
data[type=ohlc]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=ohlc].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=ohlc].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=ohlc].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

split
Parent:
data[type=ohlc].hoverlabel
Type:
boolean

Show hover information (open, close, high, low) in separate labels.

hovertext
Parent:
data[type=ohlc]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=ohlc]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

increasing
Parent:
data[type=ohlc]
Type:
object containing one or more of the keys listed below.
Default:
"#3D9970"

Sets the line color.

line
Parent:
data[type=ohlc].increasing
Type:
object containing one or more of the keys listed below.
Default:
"#3D9970"

Sets the line color.

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:
2

Sets the line width (in px).

legendgroup
Parent:
data[type=ohlc]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=ohlc]
Type:
object containing one or more of the keys listed below.
Default:
2

[object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.

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`.

low
Parent:
data[type=ohlc]
Type:
data array

Sets the low values.

meta
Parent:
data[type=ohlc]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=ohlc]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=ohlc]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

open
Parent:
data[type=ohlc]
Type:
data array

Sets the open values.

selectedpoints
Parent:
data[type=ohlc]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=ohlc]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

tickwidth
Parent:
data[type=ohlc]
Type:
number between or equal to 0 and 0.5
Default:
0.3

Sets the width of the open/close tick marks relative to the "x" minimal interval.

type
Parent:
data[type=ohlc]
Type:
"ohlc"
uirevision
Parent:
data[type=ohlc]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=ohlc]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=ohlc]
Type:
data array

Sets the x coordinates. If absent, linear coordinate will be generated.

xaxis
Parent:
data[type=ohlc]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=ohlc]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

yaxis
Parent:
data[type=ohlc]
Type:
subplotid
Default:
y

Sets 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.

16. Candlestick traces

A 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.

close
Parent:
data[type=candlestick]
Type:
data array

Sets the close values.

customdata
Parent:
data[type=candlestick]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

decreasing
Parent:
data[type=candlestick]
Type:
object containing one or more of the keys listed below.
Default:
"#FF4136"

Sets the color of line bounding the box(es).

fillcolor
Parent:
data[type=candlestick].decreasing
Type:
color

Sets 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.
Default:
"#FF4136"

Sets the color of line bounding the box(es).

color
Parent:
data[type=candlestick].decreasing.line
Type:
color
Default:
"#FF4136"

Sets the color of line bounding the box(es).

width
Parent:
data[type=candlestick].decreasing.line
Type:
number greater than or equal to 0
Default:
2

Sets the width (in px) of line bounding the box(es).

high
Parent:
data[type=candlestick]
Type:
data array

Sets the high values.

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".
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.

hoverlabel
Parent:
data[type=candlestick]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=candlestick].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=candlestick].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=candlestick].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

split
Parent:
data[type=candlestick].hoverlabel
Type:
boolean

Show hover information (open, close, high, low) in separate labels.

hovertext
Parent:
data[type=candlestick]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=candlestick]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

increasing
Parent:
data[type=candlestick]
Type:
object containing one or more of the keys listed below.
Default:
"#3D9970"

Sets the color of line bounding the box(es).

fillcolor
Parent:
data[type=candlestick].increasing
Type:
color

Sets 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.
Default:
"#3D9970"

Sets the color of line bounding the box(es).

color
Parent:
data[type=candlestick].increasing.line
Type:
color
Default:
"#3D9970"

Sets the color of line bounding the box(es).

width
Parent:
data[type=candlestick].increasing.line
Type:
number greater than or equal to 0
Default:
2

Sets the width (in px) of line bounding the box(es).

legendgroup
Parent:
data[type=candlestick]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=candlestick]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets 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
Parent:
data[type=candlestick].line
Type:
number greater than or equal to 0
Default:
2

Sets 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`.

low
Parent:
data[type=candlestick]
Type:
data array

Sets the low values.

meta
Parent:
data[type=candlestick]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=candlestick]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=candlestick]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

open
Parent:
data[type=candlestick]
Type:
data array

Sets the open values.

selectedpoints
Parent:
data[type=candlestick]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=candlestick]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

type
Parent:
data[type=candlestick]
Type:
"candlestick"
uirevision
Parent:
data[type=candlestick]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=candlestick]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

whiskerwidth
Parent:
data[type=candlestick]
Type:
number between or equal to 0 and 1
Default:
0

Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

x
Parent:
data[type=candlestick]
Type:
data array

Sets the x coordinates. If absent, linear coordinate will be generated.

xaxis
Parent:
data[type=candlestick]
Type:
subplotid
Default:
x

Sets 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.

xcalendar
Parent:
data[type=candlestick]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

yaxis
Parent:
data[type=candlestick]
Type:
subplotid
Default:
y

Sets 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.

17. Waterfall traces

A 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 th "v" (the default) and the labels are set in `x`. By setting `orientation` to "h", the roles are interchanged.

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.

base
Parent:
data[type=waterfall]
Type:
number

Sets where the bar base is drawn (in position axis units).

cliponaxis
Parent:
data[type=waterfall]
Type:
boolean
Default:
true

Determines 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.
Default:
"#444"

Sets the line color.

line
Parent:
data[type=waterfall].connector
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the line color.

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:
2

Sets the line width (in px).

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:
true

Determines if connector lines are drawn.

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.

customdata
Parent:
data[type=waterfall]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

decreasing
Parent:
data[type=waterfall]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the marker color of all decreasing values.

marker
Parent:
data[type=waterfall].decreasing
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the marker color of all decreasing values.

color
Parent:
data[type=waterfall].decreasing.marker
Type:
color

Sets the marker color of all decreasing values.

line
Parent:
data[type=waterfall].decreasing.marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the line color of all decreasing values.

color
Parent:
data[type=waterfall].decreasing.marker.line
Type:
color

Sets the line color of all decreasing values.

width
Parent:
data[type=waterfall].decreasing.marker.line
Type:
number greater than or equal to 0
Default:
0

Sets the line width of all decreasing values.

dx
Parent:
data[type=waterfall]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=waterfall]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

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".
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.

hoverlabel
Parent:
data[type=waterfall]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=waterfall].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=waterfall].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=waterfall].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

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.

ids
Parent:
data[type=waterfall]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

increasing
Parent:
data[type=waterfall]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the marker color of all increasing values.

marker
Parent:
data[type=waterfall].increasing
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the marker color of all increasing values.

color
Parent:
data[type=waterfall].increasing.marker
Type:
color

Sets the marker color of all increasing values.

line
Parent:
data[type=waterfall].increasing.marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the line color of all increasing values.

color
Parent:
data[type=waterfall].increasing.marker.line
Type:
color

Sets the line color of all increasing values.

width
Parent:
data[type=waterfall].increasing.marker.line
Type:
number greater than or equal to 0
Default:
0

Sets the line width of all increasing values.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=waterfall].insidetextfont
Type:
number or array of numbers greater than or equal to 1
legendgroup
Parent:
data[type=waterfall]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

measure
Parent:
data[type=waterfall]
Type:
data array

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.

meta
Parent:
data[type=waterfall]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=waterfall]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

offset
Parent:
data[type=waterfall]
Type:
number or array of numbers

Shifts 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.

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.

opacity
Parent:
data[type=waterfall]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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).

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=waterfall].outsidetextfont
Type:
number or array of numbers greater than or equal to 1
selectedpoints
Parent:
data[type=waterfall]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=waterfall]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=waterfall].textfont
Type:
number or array of numbers greater than or equal to 1
textinfo
Parent:
data[type=waterfall]
Type:
flaglist string. Any combination of "label", "text", "initial", "delta", "final" joined with a "+" OR "none".

Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

textposition
Parent:
data[type=waterfall]
Type:
enumerated or array of enumerateds , one of ( "inside" | "outside" | "auto" | "none" )
Default:
"none"

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.

texttemplate
Parent:
data[type=waterfall]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `initial`, `delta`, `final` and `label`.

totals
Parent:
data[type=waterfall]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the marker color of all intermediate sums and total values.

marker
Parent:
data[type=waterfall].totals
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the marker color of all intermediate sums and total values.

color
Parent:
data[type=waterfall].totals.marker
Type:
color

Sets the marker color of all intermediate sums and total values.

line
Parent:
data[type=waterfall].totals.marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the line color of all intermediate sums and total values.

color
Parent:
data[type=waterfall].totals.marker.line
Type:
color

Sets the line color of all intermediate sums and total values.

width
Parent:
data[type=waterfall].totals.marker.line
Type:
number greater than or equal to 0
Default:
0

Sets the line width of all intermediate sums and total values.

type
Parent:
data[type=waterfall]
Type:
"waterfall"
uirevision
Parent:
data[type=waterfall]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=waterfall]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width
Parent:
data[type=waterfall]
Type:
number or array of numbers greater than or equal to 0

Sets the bar width (in position axis units).

x
Parent:
data[type=waterfall]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=waterfall]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=waterfall]
Type:
subplotid
Default:
x

Sets 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.

y
Parent:
data[type=waterfall]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=waterfall]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=waterfall]
Type:
subplotid
Default:
y

Sets 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.

18. Funnel traces

A 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.

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.

cliponaxis
Parent:
data[type=funnel]
Type:
boolean
Default:
true

Determines 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.
Default:
"#444"

Sets the fill color.

fillcolor
Parent:
data[type=funnel].connector
Type:
color

Sets the fill color.

line
Parent:
data[type=funnel].connector
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the line color.

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:
0

Sets the line width (in px).

visible
Parent:
data[type=funnel].connector
Type:
boolean
Default:
true

Determines if connector regions and lines are drawn.

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.

customdata
Parent:
data[type=funnel]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dx
Parent:
data[type=funnel]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

dy
Parent:
data[type=funnel]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

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".
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.

hoverlabel
Parent:
data[type=funnel]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=funnel].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnel].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=funnel].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

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.

ids
Parent:
data[type=funnel]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnel].insidetextfont
Type:
number or array of numbers greater than or equal to 1
legendgroup
Parent:
data[type=funnel]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=funnel]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=funnel].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=funnel].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=funnel].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=funnel].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=funnel].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=funnel].marker.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnel].marker.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=funnel].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=funnel].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=funnel].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=funnel].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=funnel].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=funnel].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=funnel].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=funnel].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=funnel].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnel].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=funnel].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=funnel].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=funnel].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=funnel].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=funnel].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=funnel].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=funnel].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=funnel].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=funnel].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=funnel].marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=funnel].marker.line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarker.linecolor. 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:
subplotid

Sets 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:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=funnel].marker.line
Type:
boolean

Reverses 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:
0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=funnel].marker
Type:
number or array of numbers between or equal to 0 and 1
Default:
1

Sets the opacity of the bars.

reversescale
Parent:
data[type=funnel].marker
Type:
boolean

Reverses 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:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

meta
Parent:
data[type=funnel]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=funnel]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

offset
Parent:
data[type=funnel]
Type:
number

Shifts 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.

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.

opacity
Parent:
data[type=funnel]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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".

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnel].outsidetextfont
Type:
number or array of numbers greater than or equal to 1
selectedpoints
Parent:
data[type=funnel]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=funnel]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

textangle
Parent:
data[type=funnel]
Type:
angle
Default:
0

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=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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnel].textfont
Type:
number or array of numbers greater than or equal to 1
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".

Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

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.

texttemplate
Parent:
data[type=funnel]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`.

type
Parent:
data[type=funnel]
Type:
"funnel"
uirevision
Parent:
data[type=funnel]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=funnel]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width
Parent:
data[type=funnel]
Type:
number greater than or equal to 0

Sets the bar width (in position axis units).

x
Parent:
data[type=funnel]
Type:
data array

Sets the x coordinates.

x0
Parent:
data[type=funnel]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

xaxis
Parent:
data[type=funnel]
Type:
subplotid
Default:
x

Sets 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.

y
Parent:
data[type=funnel]
Type:
data array

Sets the y coordinates.

y0
Parent:
data[type=funnel]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

yaxis
Parent:
data[type=funnel]
Type:
subplotid
Default:
y

Sets 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.

19. Funnelarea traces

A 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.

aspectratio
Parent:
data[type=funnelarea]
Type:
number greater than or equal to 0
Default:
1

Sets the ratio between height and width

baseratio
Parent:
data[type=funnelarea]
Type:
number between or equal to 0 and 1
Default:
0.333

Sets the ratio between bottom length and maximum top length.

customdata
Parent:
data[type=funnelarea]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dlabel
Parent:
data[type=funnelarea]
Type:
number
Default:
1

Sets the label step. See `label0` for more info.

domain
Parent:
data[type=funnelarea]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this funnelarea trace (in plot fraction).

column
Parent:
data[type=funnelarea].domain
Type:
integer greater than or equal to 0
Default:
0

If 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:
0

If 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).

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".
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.

hoverlabel
Parent:
data[type=funnelarea]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=funnelarea].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnelarea].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=funnelarea].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

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.

ids
Parent:
data[type=funnelarea]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnelarea].insidetextfont
Type:
number or array of numbers greater than or equal to 1
label0
Parent:
data[type=funnelarea]
Type:
number
Default:
0

Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.

labels
Parent:
data[type=funnelarea]
Type:
data array

Sets 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.

legendgroup
Parent:
data[type=funnelarea]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=funnelarea]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

colors
Parent:
data[type=funnelarea].marker
Type:
data array

Sets 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.
Default:
1

Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

color
Parent:
data[type=funnelarea].marker.line
Type:
color or array of colors

Sets 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:
1

Sets the width (in px) of the line enclosing each sector.

meta
Parent:
data[type=funnelarea]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=funnelarea]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=funnelarea]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

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.

showlegend
Parent:
data[type=funnelarea]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

text
Parent:
data[type=funnelarea]
Type:
data array

Sets 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.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnelarea].textfont
Type:
number or array of numbers greater than or equal to 1
textinfo
Parent:
data[type=funnelarea]
Type:
flaglist string. Any combination of "label", "text", "value", "percent" joined with a "+" OR "none".

Determines which trace information appear on the graph.

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 appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `label`, `color`, `value`, `text` and `percent`.

title
Parent:
data[type=funnelarea]
Type:
object containing one or more of the keys listed below.
Default:
""

Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=funnelarea].title
Type:
object containing one or more of the keys listed below.

Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=funnelarea].title.font
Type:
number or array of numbers greater than or equal to 1
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`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.

text
Parent:
data[type=funnelarea].title
Type:
string
Default:
""

Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
data[type=funnelarea]
Type:
"funnelarea"
uirevision
Parent:
data[type=funnelarea]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

values
Parent:
data[type=funnelarea]
Type:
data array

Sets the values of the sectors. If omitted, we count occurrences of each label.

visible
Parent:
data[type=funnelarea]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

20. Indicator traces

A indicator trace is an object with the key "type" equal to "indicator" (i.e. {"type": "indicator"}) and any of the keys listed below. An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges.

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

customdata
Parent:
data[type=indicator]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

delta
Parent:
data[type=indicator]
Type:
object containing one or more of the keys listed below.
Default:
"bottom"

Sets the reference value to compute the delta. By default, it is set to the current value.

decreasing
Parent:
data[type=indicator].delta
Type:
object containing one or more of the keys listed below.
Default:
"&#x25BC;"

Sets the symbol to display for increasing value

color
Parent:
data[type=indicator].delta.decreasing
Type:
color
Default:
"#FF4136"

Sets the color for increasing value.

symbol
Parent:
data[type=indicator].delta.decreasing
Type:
string
Default:
"&#x25BC;"

Sets the symbol to display for increasing value

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=indicator].delta.font
Type:
number greater than or equal to 1
increasing
Parent:
data[type=indicator].delta
Type:
object containing one or more of the keys listed below.
Default:
"&#x25B2;"

Sets the symbol to display for increasing value

color
Parent:
data[type=indicator].delta.increasing
Type:
color
Default:
"#3D9970"

Sets the color for increasing value.

symbol
Parent:
data[type=indicator].delta.increasing
Type:
string
Default:
"&#x25B2;"

Sets the symbol to display for increasing value

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.

reference
Parent:
data[type=indicator].delta
Type:
number

Sets the reference value to compute the delta. By default, it is set to the current value.

relative
Parent:
data[type=indicator].delta
Type:
boolean

Show relative change

valueformat
Parent:
data[type=indicator].delta
Type:
string

Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

domain
Parent:
data[type=indicator]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this indicator trace (in plot fraction).

column
Parent:
data[type=indicator].domain
Type:
integer greater than or equal to 0
Default:
0

If 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:
0

If 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).

gauge
Parent:
data[type=indicator]
Type:
object containing one or more of the keys listed below.
Default:
"angular"

The gauge of the Indicator plot.

axis
Parent:
data[type=indicator].gauge
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the range of this axis.

dtick
Parent:
data[type=indicator].gauge.axis
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=indicator].gauge.axis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

nticks
Parent:
data[type=indicator].gauge.axis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
data[type=indicator].gauge.axis
Type:
array

Sets the range of this axis.

separatethousands
Parent:
data[type=indicator].gauge.axis
Type:
boolean

If "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:
true

Determines 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=indicator].gauge.axis.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=indicator].gauge.axis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=indicator].gauge.axis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=indicator].gauge.axis.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=indicator].gauge.axis.tickformatstops[]
Type:
string

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

value
Parent:
data[type=indicator].gauge.axis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=indicator].gauge.axis
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

visible
Parent:
data[type=indicator].gauge.axis
Type:
boolean
Default:
true

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

bar
Parent:
data[type=indicator].gauge
Type:
object containing one or more of the keys listed below.
Default:
"green"

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.
Default:
"#444"

Sets the color of the line enclosing each sector.

color
Parent:
data[type=indicator].gauge.bar.line
Type:
color
Default:
"#444"

Sets the color of the line enclosing each sector.

width
Parent:
data[type=indicator].gauge.bar.line
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) of the line enclosing each sector.

thickness
Parent:
data[type=indicator].gauge.bar
Type:
number between or equal to 0 and 1
Default:
1

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

bgcolor
Parent:
data[type=indicator].gauge
Type:
color

Sets 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:
1

Sets 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.
Default:
"#444"

Sets the background color of the arc.

color
Parent:
data[type=indicator].gauge.steps[]
Type:
color

Sets the background color of the arc.

line
Parent:
data[type=indicator].gauge.steps[]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the color of the line enclosing each sector.

color
Parent:
data[type=indicator].gauge.steps[].line
Type:
color
Default:
"#444"

Sets the color of the line enclosing each sector.

width
Parent:
data[type=indicator].gauge.steps[].line
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) of the line enclosing each sector.

name
Parent:
data[type=indicator].gauge.steps[]
Type:
string

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

range
Parent:
data[type=indicator].gauge.steps[]
Type:
array

Sets the range of this axis.

templateitemname
Parent:
data[type=indicator].gauge.steps[]
Type:
string

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

thickness
Parent:
data[type=indicator].gauge.steps[]
Type:
number between or equal to 0 and 1
Default:
1

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

threshold
Parent:
data[type=indicator].gauge
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the color of the threshold line.

line
Parent:
data[type=indicator].gauge.threshold
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the color of the threshold line.

color
Parent:
data[type=indicator].gauge.threshold.line
Type:
color
Default:
"#444"

Sets the color of the threshold line.

width
Parent:
data[type=indicator].gauge.threshold.line
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the threshold line.

thickness
Parent:
data[type=indicator].gauge.threshold
Type:
number between or equal to 0 and 1
Default:
0.85

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

value
Parent:
data[type=indicator].gauge.threshold
Type:
number

Sets a treshold value drawn as a line.

ids
Parent:
data[type=indicator]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

meta
Parent:
data[type=indicator]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=indicator]
Type:
flaglist string. Any combination of "number", "delta", "gauge" joined with a "+"
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.

name
Parent:
data[type=indicator]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

number
Parent:
data[type=indicator]
Type:
object containing one or more of the keys listed below.
Default:
""

Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=indicator].number.font
Type:
number greater than or equal to 1
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-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

title
Parent:
data[type=indicator]
Type:
object containing one or more of the keys listed below.

Sets the title of this indicator.

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=indicator].title.font
Type:
number greater than or equal to 1
text
Parent:
data[type=indicator].title
Type:
string

Sets the title of this indicator.

type
Parent:
data[type=indicator]
Type:
"indicator"
uirevision
Parent:
data[type=indicator]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

value
Parent:
data[type=indicator]
Type:
number

Sets the number to be displayed.

visible
Parent:
data[type=indicator]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

21. Scatter3d traces

A 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`.

connectgaps
Parent:
data[type=scatter3d]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scatter3d]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

error_x
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scatter3d].error_x
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

copy_zstyle
Parent:
data[type=scatter3d].error_x
Type:
boolean
symmetric
Parent:
data[type=scatter3d].error_x
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scatter3d].error_x
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scatter3d].error_y
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

copy_zstyle
Parent:
data[type=scatter3d].error_y
Type:
boolean
symmetric
Parent:
data[type=scatter3d].error_y
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scatter3d].error_y
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_z
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
10

Determines whether or not this set of error bars is visible.

array
Parent:
data[type=scatter3d].error_z
Type:
data array

Sets 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 array

Sets 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:
color

Sets the stoke color of the error bars.

symmetric
Parent:
data[type=scatter3d].error_z
Type:
boolean

Determines 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:
2

Sets 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 sqaure 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:
10

Sets 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:
10

Sets 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:
boolean

Determines whether or not this set of error bars is visible.

width
Parent:
data[type=scatter3d].error_z
Type:
number greater than or equal to 0

Sets the width (in px) of the cross-bar at both ends of the error bars.

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".
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.

hoverlabel
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scatter3d].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter3d].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scatter3d].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

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.

ids
Parent:
data[type=scatter3d]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scatter3d]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line width (in px).

autocolorscale
Parent:
data[type=scatter3d].line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets thelinecolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scatter3d].line.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scatter3d].line.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scatter3d].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=scatter3d].line.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scatter3d].line.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter3d].line.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scatter3d].line.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scatter3d].line.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scatter3d].line.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=scatter3d].line.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scatter3d].line.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scatter3d].line.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=scatter3d].line.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scatter3d].line.colorbar.title.font
Type:
color
family
Parent:
data[type=scatter3d].line.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter3d].line.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scatter3d].line.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scatter3d].line.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scatter3d].line.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scatter3d].line.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scatter3d].line.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scatter3d].line.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scatter3d].line.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scatter3d].line.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scatter3d].line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

dash
Parent:
data[type=scatter3d].line
Type:
enumerated , one of ( "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
Default:
"solid"

Sets the dash style of the lines.

reversescale
Parent:
data[type=scatter3d].line
Type:
boolean

Reverses 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:
boolean

Determines 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:
2

Sets the line width (in px).

marker
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
"circle"

Sets the marker symbol type.

autocolorscale
Parent:
data[type=scatter3d].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scatter3d].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scatter3d].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scatter3d].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=scatter3d].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scatter3d].marker.colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter3d].marker.colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scatter3d].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scatter3d].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scatter3d].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=scatter3d].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scatter3d].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scatter3d].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=scatter3d].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scatter3d].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scatter3d].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter3d].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scatter3d].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scatter3d].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scatter3d].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scatter3d].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scatter3d].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scatter3d].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scatter3d].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scatter3d].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scatter3d].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=scatter3d].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=scatter3d].marker.line
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarker.linecolor. 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:
subplotid

Sets 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:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scatter3d].marker.line
Type:
boolean

Reverses 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 0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=scatter3d].marker
Type:
number between or equal to 0 and 1

Sets 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:
boolean

Reverses 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:
boolean

Determines 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:
8

Sets the marker size (in px).

sizemin
Parent:
data[type=scatter3d].marker
Type:
number greater than or equal to 0
Default:
0

Has 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:
1

Has 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" | "square" | "square-open" | "diamond" | "diamond-open" | "cross" | "x" )
Default:
"circle"

Sets the marker symbol type.

meta
Parent:
data[type=scatter3d]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scatter3d]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scatter3d]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scatter3d]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

projection
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets whether or not projections are shown along the x axis.

x
Parent:
data[type=scatter3d].projection
Type:
object containing one or more of the keys listed below.
Default:
1

Sets whether or not projections are shown along the x axis.

opacity
Parent:
data[type=scatter3d].projection.x
Type:
number between or equal to 0 and 1
Default:
1

Sets the projection color.

scale
Parent:
data[type=scatter3d].projection.x
Type:
number between or equal to 0 and 10
Default:
0.6666666666666666

Sets the scale factor determining the size of the projection marker points.

show
Parent:
data[type=scatter3d].projection.x
Type:
boolean

Sets whether or not projections are shown along the x axis.

y
Parent:
data[type=scatter3d].projection
Type:
object containing one or more of the keys listed below.
Default:
1

Sets whether or not projections are shown along the y axis.

opacity
Parent:
data[type=scatter3d].projection.y
Type:
number between or equal to 0 and 1
Default:
1

Sets the projection color.

scale
Parent:
data[type=scatter3d].projection.y
Type:
number between or equal to 0 and 10
Default:
0.6666666666666666

Sets the scale factor determining the size of the projection marker points.

show
Parent:
data[type=scatter3d].projection.y
Type:
boolean

Sets whether or not projections are shown along the y axis.

z
Parent:
data[type=scatter3d].projection
Type:
object containing one or more of the keys listed below.
Default:
1

Sets whether or not projections are shown along the z axis.

opacity
Parent:
data[type=scatter3d].projection.z
Type:
number between or equal to 0 and 1
Default:
1

Sets the projection color.

scale
Parent:
data[type=scatter3d].projection.z
Type:
number between or equal to 0 and 10
Default:
0.6666666666666666

Sets the scale factor determining the size of the projection marker points.

show
Parent:
data[type=scatter3d].projection.z
Type:
boolean

Sets whether or not projections are shown along the z axis.

scene
Parent:
data[type=scatter3d]
Type:
subplotid
Default:
scene

Sets 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.

showlegend
Parent:
data[type=scatter3d]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

surfacecolor
Parent:
data[type=scatter3d]
Type:
color

Sets 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.

textfont
Parent:
data[type=scatter3d]
Type:
object containing one or more of the keys listed below.

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

color
Parent:
data[type=scatter3d].textfont
Type:
color or array of colors
family
Parent:
data[type=scatter3d].textfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatter3d].textfont
Type:
number or array of numbers greater than or equal to 1
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 appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

type
Parent:
data[type=scatter3d]
Type:
"scatter3d"
uirevision
Parent:
data[type=scatter3d]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=scatter3d]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=scatter3d]
Type:
data array

Sets the x coordinates.

xcalendar
Parent:
data[type=scatter3d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=scatter3d]
Type:
data array

Sets the y coordinates.

ycalendar
Parent:
data[type=scatter3d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

z
Parent:
data[type=scatter3d]
Type:
data array

Sets the z coordinates.

zcalendar
Parent:
data[type=scatter3d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `z` date data.

22. Surface traces

A 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`.

autocolorscale
Parent:
data[type=surface]
Type:
boolean

Determines 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.

cauto
Parent:
data[type=surface]
Type:
boolean
Default:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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.

coloraxis
Parent:
data[type=surface]
Type:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=surface].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=surface].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=surface].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=surface].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=surface].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=surface].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=surface].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=surface].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=surface].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=surface].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=surface].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=surface].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=surface].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=surface].colorbar.title.font
Type:
color
family
Parent:
data[type=surface].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=surface].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=surface].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=surface].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=surface].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=surface].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=surface].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=surface].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=surface].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=surface].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=surface]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

connectgaps
Parent:
data[type=surface]
Type:
boolean

Determines 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.
Default:
"#444"

Determines whether or not contour lines about the x dimension are drawn.

x
Parent:
data[type=surface].contours
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Determines whether or not contour lines about the x dimension are drawn.

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:
number

Sets the end contour level value. Must be more than `contours.start`

highlight
Parent:
data[type=surface].contours.x
Type:
boolean
Default:
true

Determines 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:
2

Sets 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.

Determines 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.

x
Parent:
data[type=surface].contours.x.project
Type:
boolean

Determines 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:
boolean

Determines 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:
boolean

Determines 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.

show
Parent:
data[type=surface].contours.x
Type:
boolean

Determines 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 0

Sets the step between each contour level. Must be positive.

start
Parent:
data[type=surface].contours.x
Type:
number

Sets the starting contour level value. Must be less than `contours.end`

usecolormap
Parent:
data[type=surface].contours.x
Type:
boolean

An 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:
2

Sets the width of the contour lines.

y
Parent:
data[type=surface].contours
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Determines whether or not contour lines about the y dimension are drawn.

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:
number

Sets the end contour level value. Must be more than `contours.start`

highlight
Parent:
data[type=surface].contours.y
Type:
boolean
Default:
true

Determines 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:
2

Sets 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.

Determines 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.

x
Parent:
data[type=surface].contours.y.project
Type:
boolean

Determines 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:
boolean

Determines 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:
boolean

Determines 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.

show
Parent:
data[type=surface].contours.y
Type:
boolean

Determines 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 0

Sets the step between each contour level. Must be positive.

start
Parent:
data[type=surface].contours.y
Type:
number

Sets the starting contour level value. Must be less than `contours.end`

usecolormap
Parent:
data[type=surface].contours.y
Type:
boolean

An 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:
2

Sets the width of the contour lines.

z
Parent:
data[type=surface].contours
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Determines whether or not contour lines about the z dimension are drawn.

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:
number

Sets the end contour level value. Must be more than `contours.start`

highlight
Parent:
data[type=surface].contours.z
Type:
boolean
Default:
true

Determines 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:
2

Sets 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.

Determines 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.

x
Parent:
data[type=surface].contours.z.project
Type:
boolean

Determines 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:
boolean

Determines 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:
boolean

Determines 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.

show
Parent:
data[type=surface].contours.z
Type:
boolean

Determines 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 0

Sets the step between each contour level. Must be positive.

start
Parent:
data[type=surface].contours.z
Type:
number

Sets the starting contour level value. Must be less than `contours.end`

usecolormap
Parent:
data[type=surface].contours.z
Type:
boolean

An 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:
2

Sets the width of the contour lines.

customdata
Parent:
data[type=surface]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

hidesurface
Parent:
data[type=surface]
Type:
boolean

Determines 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.

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".
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.

hoverlabel
Parent:
data[type=surface]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=surface].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=surface].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=surface].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=surface]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=surface]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

lighting
Parent:
data[type=surface]
Type:
object containing one or more of the keys listed below.
Default:
0.8

Ambient light increases overall color visibility but can wash out the image.

ambient
Parent:
data[type=surface].lighting
Type:
number between or equal to 0 and 1
Default:
0.8

Ambient 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.8

Represents 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.2

Represents 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.5

Alters 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.05

Represents the level that incident rays are reflected in a single direction, causing shine.

lightposition
Parent:
data[type=surface]
Type:
object containing one or more of the keys listed below.
Default:
10

Numeric vector, representing the X coordinate for each vertex.

x
Parent:
data[type=surface].lightposition
Type:
number between or equal to -100000 and 100000
Default:
10

Numeric vector, representing the X coordinate for each vertex.

y
Parent:
data[type=surface].lightposition
Type:
number between or equal to -100000 and 100000
Default:
10000

Numeric vector, representing the Y coordinate for each vertex.

z
Parent:
data[type=surface].lightposition
Type:
number between or equal to -100000 and 100000
Default:
0

Numeric vector, representing the Z coordinate for each vertex.

meta
Parent:
data[type=surface]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=surface]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=surface]
Type:
number between or equal to 0 and 1
Default:
1

Sets 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.

reversescale
Parent:
data[type=surface]
Type:
boolean

Reverses 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.

scene
Parent:
data[type=surface]
Type:
subplotid
Default:
scene

Sets 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.

showscale
Parent:
data[type=surface]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

surfacecolor
Parent:
data[type=surface]
Type:
data array

Sets 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.

type
Parent:
data[type=surface]
Type:
"surface"
uirevision
Parent:
data[type=surface]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=surface]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=surface]
Type:
data array

Sets the x coordinates.

xcalendar
Parent:
data[type=surface]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=surface]
Type:
data array

Sets the y coordinates.

ycalendar
Parent:
data[type=surface]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

z
Parent:
data[type=surface]
Type:
data array

Sets the z coordinates.

zcalendar
Parent:
data[type=surface]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `z` date data.

23. Mesh3d traces

A 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

alphahull
Parent:
data[type=mesh3d]
Type:
number
Default:
-1

Determines 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.

autocolorscale
Parent:
data[type=mesh3d]
Type:
boolean
Default:
true

Determines 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.

cauto
Parent:
data[type=mesh3d]
Type:
boolean
Default:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.

color
Parent:
data[type=mesh3d]
Type:
color

Sets the color of the whole mesh

coloraxis
Parent:
data[type=mesh3d]
Type:
subplotid

Sets 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=mesh3d]
Type:
object containing one or more of the keys listed below.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=mesh3d].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=mesh3d].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=mesh3d].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=mesh3d].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=mesh3d].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=mesh3d].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=mesh3d].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=mesh3d].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=mesh3d].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=mesh3d].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=mesh3d].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=mesh3d].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=mesh3d].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=mesh3d].colorbar.title.font
Type:
color
family
Parent:
data[type=mesh3d].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=mesh3d].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=mesh3d].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=mesh3d].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=mesh3d].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=mesh3d].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=mesh3d].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=mesh3d].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=mesh3d].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=mesh3d].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=mesh3d]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

contour
Parent:
data[type=mesh3d]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets whether or not dynamic contours are shown on hover

color
Parent:
data[type=mesh3d].contour
Type:
color
Default:
"#444"

Sets the color of the contour lines.

show
Parent:
data[type=mesh3d].contour
Type:
boolean

Sets 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:
2

Sets the width of the contour lines.

customdata
Parent:
data[type=mesh3d]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

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.

facecolor
Parent:
data[type=mesh3d]
Type:
data array

Sets the color of each face Overrides "color" and "vertexcolor".

flatshading
Parent:
data[type=mesh3d]
Type:
boolean

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

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".
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.

hoverlabel
Parent:
data[type=mesh3d]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=mesh3d].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=mesh3d].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=mesh3d].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=mesh3d]
Type:
string or array of strings
Default:
""

Same as `text`.

i
Parent:
data[type=mesh3d]
Type:
data array

A 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.

ids
Parent:
data[type=mesh3d]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

intensity
Parent:
data[type=mesh3d]
Type:
data array

Sets the vertex intensity values, used for plotting fields on meshes

j
Parent:
data[type=mesh3d]
Type:
data array

A 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 array

A 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.

lighting
Parent:
data[type=mesh3d]
Type:
object containing one or more of the keys listed below.
Default:
1e-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

ambient
Parent:
data[type=mesh3d].lighting
Type:
number between or equal to 0 and 1
Default:
0.8

Ambient 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.8

Represents 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-06

Epsilon 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.2

Represents 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.5

Alters 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.05

Represents 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-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition
Parent:
data[type=mesh3d]
Type:
object containing one or more of the keys listed below.
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

x
Parent:
data[type=mesh3d].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

y
Parent:
data[type=mesh3d].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the Y coordinate for each vertex.

z
Parent:
data[type=mesh3d].lightposition
Type:
number between or equal to -100000 and 100000
Default:
0

Numeric vector, representing the Z coordinate for each vertex.

meta
Parent:
data[type=mesh3d]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=mesh3d]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=mesh3d]
Type:
number between or equal to 0 and 1
Default:
1

Sets 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.

reversescale
Parent:
data[type=mesh3d]
Type:
boolean

Reverses 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.

scene
Parent:
data[type=mesh3d]
Type:
subplotid
Default:
scene

Sets 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.

showscale
Parent:
data[type=mesh3d]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

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.

type
Parent:
data[type=mesh3d]
Type:
"mesh3d"
uirevision
Parent:
data[type=mesh3d]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

vertexcolor
Parent:
data[type=mesh3d]
Type:
data array

Sets 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.

visible
Parent:
data[type=mesh3d]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=mesh3d]
Type:
data array

Sets 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.

xcalendar
Parent:
data[type=mesh3d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `x` date data.

y
Parent:
data[type=mesh3d]
Type:
data array

Sets 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.

ycalendar
Parent:
data[type=mesh3d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `y` date data.

z
Parent:
data[type=mesh3d]
Type:
data array

Sets 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.

zcalendar
Parent:
data[type=mesh3d]
Type:
enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
Default:
"gregorian"

Sets the calendar system to use with `z` date data.

24. Cone traces

A 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`.

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.

autocolorscale
Parent:
data[type=cone]
Type:
boolean
Default:
true

Determines 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.

cauto
Parent:
data[type=cone]
Type:
boolean
Default:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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.

coloraxis
Parent:
data[type=cone]
Type:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=cone].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=cone].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=cone].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=cone].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=cone].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=cone].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=cone].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=cone].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=cone].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=cone].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=cone].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=cone].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=cone].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=cone].colorbar.title.font
Type:
color
family
Parent:
data[type=cone].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=cone].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=cone].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=cone].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=cone].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=cone].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=cone].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=cone].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=cone].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=cone].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=cone]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=cone]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

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".
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.

hoverlabel
Parent:
data[type=cone]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=cone].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=cone].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=cone].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

hovertext
Parent:
data[type=cone]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=cone]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

lighting
Parent:
data[type=cone]
Type:
object containing one or more of the keys listed below.
Default:
1e-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

ambient
Parent:
data[type=cone].lighting
Type:
number between or equal to 0 and 1
Default:
0.8

Ambient 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.8

Represents 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-06

Epsilon 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.2

Represents 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.5

Alters 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.05

Represents 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-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition
Parent:
data[type=cone]
Type:
object containing one or more of the keys listed below.
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

x
Parent:
data[type=cone].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

y
Parent:
data[type=cone].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the Y coordinate for each vertex.

z
Parent:
data[type=cone].lightposition
Type:
number between or equal to -100000 and 100000
Default:
0

Numeric vector, representing the Z coordinate for each vertex.

meta
Parent:
data[type=cone]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=cone]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=cone]
Type:
number between or equal to 0 and 1
Default:
1

Sets 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.

reversescale
Parent:
data[type=cone]
Type:
boolean

Reverses 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.

scene
Parent:
data[type=cone]
Type:
subplotid
Default:
scene

Sets 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.

showscale
Parent:
data[type=cone]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

sizemode
Parent:
data[type=cone]
Type:
enumerated , one of ( "scaled" | "absolute" )
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).

sizeref
Parent:
data[type=cone]
Type:
number greater than or equal to 0

Adjusts 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 "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.

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.

type
Parent:
data[type=cone]
Type:
"cone"
u
Parent:
data[type=cone]
Type:
data array

Sets the x components of the vector field.

uirevision
Parent:
data[type=cone]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

v
Parent:
data[type=cone]
Type:
data array

Sets the y components of the vector field.

visible
Parent:
data[type=cone]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

w
Parent:
data[type=cone]
Type:
data array

Sets the z components of the vector field.

x
Parent:
data[type=cone]
Type:
data array

Sets the x coordinates of the vector field and of the displayed cones.

y
Parent:
data[type=cone]
Type:
data array

Sets the y coordinates of the vector field and of the displayed cones.

z
Parent:
data[type=cone]
Type:
data array

Sets the z coordinates of the vector field and of the displayed cones.

25. Streamtube traces

A 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).

autocolorscale
Parent:
data[type=streamtube]
Type:
boolean
Default:
true

Determines 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.

cauto
Parent:
data[type=streamtube]
Type:
boolean
Default:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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.

coloraxis
Parent:
data[type=streamtube]
Type:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=streamtube].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=streamtube].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=streamtube].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=streamtube].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=streamtube].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=streamtube].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=streamtube].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=streamtube].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=streamtube].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=streamtube].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=streamtube].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=streamtube].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=streamtube].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=streamtube].colorbar.title.font
Type:
color
family
Parent:
data[type=streamtube].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=streamtube].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=streamtube].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=streamtube].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=streamtube].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=streamtube].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=streamtube].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=streamtube].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=streamtube].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=streamtube].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=streamtube]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=streamtube]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

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".
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.

hoverlabel
Parent:
data[type=streamtube]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=streamtube].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=streamtube].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=streamtube].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

hovertext
Parent:
data[type=streamtube]
Type:
string
Default:
""

Same as `text`.

ids
Parent:
data[type=streamtube]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

lighting
Parent:
data[type=streamtube]
Type:
object containing one or more of the keys listed below.
Default:
1e-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

ambient
Parent:
data[type=streamtube].lighting
Type:
number between or equal to 0 and 1
Default:
0.8

Ambient 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.8

Represents 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-06

Epsilon 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.2

Represents 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.5

Alters 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.05

Represents 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-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition
Parent:
data[type=streamtube]
Type:
object containing one or more of the keys listed below.
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

x
Parent:
data[type=streamtube].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

y
Parent:
data[type=streamtube].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the Y coordinate for each vertex.

z
Parent:
data[type=streamtube].lightposition
Type:
number between or equal to -100000 and 100000
Default:
0

Numeric vector, representing the Z coordinate for each vertex.

maxdisplayed
Parent:
data[type=streamtube]
Type:
integer greater than or equal to 0
Default:
1000

The maximum number of displayed segments in a streamtube.

meta
Parent:
data[type=streamtube]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=streamtube]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=streamtube]
Type:
number between or equal to 0 and 1
Default:
1

Sets 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.

reversescale
Parent:
data[type=streamtube]
Type:
boolean

Reverses 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.

scene
Parent:
data[type=streamtube]
Type:
subplotid
Default:
scene

Sets 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.

showscale
Parent:
data[type=streamtube]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

sizeref
Parent:
data[type=streamtube]
Type:
number greater than or equal to 0
Default:
1

The 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.

Sets the x components of the starting position of the streamtubes

x
Parent:
data[type=streamtube].starts
Type:
data array

Sets the x components of the starting position of the streamtubes

y
Parent:
data[type=streamtube].starts
Type:
data array

Sets the y components of the starting position of the streamtubes

z
Parent:
data[type=streamtube].starts
Type:
data array

Sets the z components of the starting position of the streamtubes

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.

type
Parent:
data[type=streamtube]
Type:
"streamtube"
u
Parent:
data[type=streamtube]
Type:
data array

Sets the x components of the vector field.

uirevision
Parent:
data[type=streamtube]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

v
Parent:
data[type=streamtube]
Type:
data array

Sets the y components of the vector field.

visible
Parent:
data[type=streamtube]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

w
Parent:
data[type=streamtube]
Type:
data array

Sets the z components of the vector field.

x
Parent:
data[type=streamtube]
Type:
data array

Sets the x coordinates of the vector field.

y
Parent:
data[type=streamtube]
Type:
data array

Sets the y coordinates of the vector field.

z
Parent:
data[type=streamtube]
Type:
data array

Sets the z coordinates of the vector field.

26. Volume traces

A 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.

autocolorscale
Parent:
data[type=volume]
Type:
boolean
Default:
true

Determines 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.

caps
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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.

x
Parent:
data[type=volume].caps
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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
Parent:
data[type=volume].caps.x
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
true

Sets 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.

y
Parent:
data[type=volume].caps
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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
Parent:
data[type=volume].caps.y
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
true

Sets 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.

z
Parent:
data[type=volume].caps
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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
Parent:
data[type=volume].caps.z
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
true

Sets 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.

cauto
Parent:
data[type=volume]
Type:
boolean
Default:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.

coloraxis
Parent:
data[type=volume]
Type:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=volume].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=volume].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=volume].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=volume].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=volume].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=volume].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=volume].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=volume].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=volume].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=volume].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=volume].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=volume].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=volume].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=volume].colorbar.title.font
Type:
color
family
Parent:
data[type=volume].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=volume].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=volume].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=volume].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=volume].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=volume].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=volume].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=volume].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=volume].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=volume].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=volume]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

contour
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets whether or not dynamic contours are shown on hover

color
Parent:
data[type=volume].contour
Type:
color
Default:
"#444"

Sets the color of the contour lines.

show
Parent:
data[type=volume].contour
Type:
boolean

Sets 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:
2

Sets the width of the contour lines.

customdata
Parent:
data[type=volume]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

flatshading
Parent:
data[type=volume]
Type:
boolean
Default:
true

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

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".
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.

hoverlabel
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=volume].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=volume].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=volume].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=volume]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=volume]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

isomax
Parent:
data[type=volume]
Type:
number

Sets the maximum boundary for iso-surface plot.

isomin
Parent:
data[type=volume]
Type:
number

Sets the minimum boundary for iso-surface plot.

lighting
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
1e-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

ambient
Parent:
data[type=volume].lighting
Type:
number between or equal to 0 and 1
Default:
0.8

Ambient 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.8

Represents 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:
0

Epsilon 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.2

Represents 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.5

Alters 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.05

Represents 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-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

x
Parent:
data[type=volume].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

y
Parent:
data[type=volume].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the Y coordinate for each vertex.

z
Parent:
data[type=volume].lightposition
Type:
number between or equal to -100000 and 100000
Default:
0

Numeric vector, representing the Z coordinate for each vertex.

meta
Parent:
data[type=volume]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=volume]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=volume]
Type:
number between or equal to 0 and 1
Default:
1

Sets 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.

opacityscale
Parent:
data[type=volume]
Type:
number or categorical coordinate string

Sets 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'.

reversescale
Parent:
data[type=volume]
Type:
boolean

Reverses 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.

scene
Parent:
data[type=volume]
Type:
subplotid
Default:
scene

Sets 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.

showscale
Parent:
data[type=volume]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

slices
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the x dimension are drawn.

x
Parent:
data[type=volume].slices
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the x dimension are drawn.

fill
Parent:
data[type=volume].slices.x
Type:
number between or equal to 0 and 1
Default:
1

Sets 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

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:
boolean

Determines whether or not slice planes about the x dimension are drawn.

y
Parent:
data[type=volume].slices
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the y dimension are drawn.

fill
Parent:
data[type=volume].slices.y
Type:
number between or equal to 0 and 1
Default:
1

Sets 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

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:
boolean

Determines whether or not slice planes about the y dimension are drawn.

z
Parent:
data[type=volume].slices
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the z dimension are drawn.

fill
Parent:
data[type=volume].slices.z
Type:
number between or equal to 0 and 1
Default:
1

Sets 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

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:
boolean

Determines whether or not slice planes about the z dimension are drawn.

spaceframe
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
1

Displays/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
Parent:
data[type=volume].spaceframe
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
boolean

Displays/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.

surface
Parent:
data[type=volume]
Type:
object containing one or more of the keys listed below.
Default:
true

Hides/displays surfaces between minimum and maximum iso-values.

count
Parent:
data[type=volume].surface
Type:
integer greater than or equal to 1
Default:
2

Sets 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:
1

Sets 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".
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:
true

Hides/displays surfaces between minimum and maximum iso-values.

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.

type
Parent:
data[type=volume]
Type:
"volume"
uirevision
Parent:
data[type=volume]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

value
Parent:
data[type=volume]
Type:
data array

Sets the 4th dimension (value) of the vertices.

visible
Parent:
data[type=volume]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=volume]
Type:
data array

Sets the X coordinates of the vertices on X axis.

y
Parent:
data[type=volume]
Type:
data array

Sets the Y coordinates of the vertices on Y axis.

z
Parent:
data[type=volume]
Type:
data array

Sets the Z coordinates of the vertices on Z axis.

27. Isosurface traces

A 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.

autocolorscale
Parent:
data[type=isosurface]
Type:
boolean
Default:
true

Determines 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.

caps
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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.

x
Parent:
data[type=isosurface].caps
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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
Parent:
data[type=isosurface].caps.x
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
true

Sets 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.

y
Parent:
data[type=isosurface].caps
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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
Parent:
data[type=isosurface].caps.y
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
true

Sets 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.

z
Parent:
data[type=isosurface].caps
Type:
object containing one or more of the keys listed below.
Default:
true

Sets 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
Parent:
data[type=isosurface].caps.z
Type:
number between or equal to 0 and 1
Default:
1

Sets 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:
true

Sets 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.

cauto
Parent:
data[type=isosurface]
Type:
boolean
Default:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.

coloraxis
Parent:
data[type=isosurface]
Type:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=isosurface].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=isosurface].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=isosurface].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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.

nticks
Parent:
data[type=isosurface].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

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:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=isosurface].colorbar
Type:
boolean

If "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:
true

Determines 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:
30

Sets 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 string

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

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:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=isosurface].colorbar.tickfont
Type:
number greater than or equal to 1
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=isosurface].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=isosurface].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=isosurface].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines 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:
string

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

templateitemname
Parent:
data[type=isosurface].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=isosurface].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=isosurface].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets 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 array

Sets 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 array

Sets 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:
1

Sets the tick width (in px).

title
Parent:
data[type=isosurface].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

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. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=isosurface].colorbar.title.font
Type:
color
family
Parent:
data[type=isosurface].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=isosurface].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=isosurface].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=isosurface].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=isosurface].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=isosurface].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=isosurface].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=isosurface].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=isosurface].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=isosurface].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=isosurface]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

contour
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets whether or not dynamic contours are shown on hover

color
Parent:
data[type=isosurface].contour
Type:
color
Default:
"#444"

Sets the color of the contour lines.

show
Parent:
data[type=isosurface].contour
Type:
boolean

Sets 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:
2

Sets the width of the contour lines.

customdata
Parent:
data[type=isosurface]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

flatshading
Parent:
data[type=isosurface]
Type:
boolean
Default:
true

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

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".
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.

hoverlabel
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

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 colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=isosurface].hoverlabel
Type:
color or array of colors

Sets 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 strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=isosurface].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=isosurface].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=isosurface]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=isosurface]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

isomax
Parent:
data[type=isosurface]
Type:
number

Sets the maximum boundary for iso-surface plot.

isomin
Parent:
data[type=isosurface]
Type:
number

Sets the minimum boundary for iso-surface plot.

lighting
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
1e-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

ambient
Parent:
data[type=isosurface].lighting
Type:
number between or equal to 0 and 1
Default:
0.8

Ambient 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.8

Represents 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:
0

Epsilon 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.2

Represents 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.5

Alters 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.05

Represents 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-12

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

x
Parent:
data[type=isosurface].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the X coordinate for each vertex.

y
Parent:
data[type=isosurface].lightposition
Type:
number between or equal to -100000 and 100000
Default:
100000

Numeric vector, representing the Y coordinate for each vertex.

z
Parent:
data[type=isosurface].lightposition
Type:
number between or equal to -100000 and 100000
Default:
0

Numeric vector, representing the Z coordinate for each vertex.

meta
Parent:
data[type=isosurface]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=isosurface]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=isosurface]
Type:
number between or equal to 0 and 1
Default:
1

Sets 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.

reversescale
Parent:
data[type=isosurface]
Type:
boolean

Reverses 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.

scene
Parent:
data[type=isosurface]
Type:
subplotid
Default:
scene

Sets 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.

showscale
Parent:
data[type=isosurface]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

slices
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the x dimension are drawn.

x
Parent:
data[type=isosurface].slices
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the x dimension are drawn.

fill
Parent:
data[type=isosurface].slices.x
Type:
number between or equal to 0 and 1
Default:
1

Sets 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

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:
boolean

Determines whether or not slice planes about the x dimension are drawn.

y
Parent:
data[type=isosurface].slices
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the y dimension are drawn.

fill
Parent:
data[type=isosurface].slices.y
Type:
number between or equal to 0 and 1
Default:
1

Sets 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

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:
boolean

Determines whether or not slice planes about the y dimension are drawn.

z
Parent:
data[type=isosurface].slices
Type:
object containing one or more of the keys listed below.

Determines whether or not slice planes about the z dimension are drawn.

fill
Parent:
data[type=isosurface].slices.z
Type:
number between or equal to 0 and 1
Default:
1

Sets 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

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:
boolean

Determines whether or not slice planes about the z dimension are drawn.

spaceframe
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
0.15

Displays/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
Parent:
data[type=isosurface].spaceframe
Type:
number between or equal to 0 and 1
Default:
0.15

Sets 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:
boolean

Displays/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.

surface
Parent:
data[type=isosurface]
Type:
object containing one or more of the keys listed below.
Default:
true

Hides/displays surfaces between minimum and maximum iso-values.

count
Parent:
data[type=isosurface].surface
Type:
integer greater than or equal to 1
Default:
2

Sets 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:
1

Sets 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".
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:
true

Hides/displays surfaces between minimum and maximum iso-values.

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.

type
Parent:
data[type=isosurface]
Type:
"isosurface"
uirevision
Parent:
data[type=isosurface]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

value
Parent:
data[type=isosurface]
Type:
data array

Sets the 4th dimension (value) of the vertices.

visible
Parent:
data[type=isosurface]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=isosurface]
Type:
data array

Sets the X coordinates of the vertices on X axis.

y
Parent:
data[type=isosurface]
Type:
data array

Sets the Y coordinates of the vertices on Y axis.

z
Parent:
data[type=isosurface]
Type:
data array

Sets the Z coordinates of the vertices on Z axis.

28. Scattergeo traces

A 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`.

connectgaps
Parent:
data[type=scattergeo]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scattergeo]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

fill
Parent:
data[type=scattergeo]
Type:
enumerated , one of ( "none" | "toself" )
Default:
"none"

Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

fillcolor
Parent:
data[type=scattergeo]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

geo
Parent:
data[type=scattergeo]
Type:
subplotid
Default:
geo

Sets 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.

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".
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.

hoverlabel
Parent:
data[type=scattergeo]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=scattergeo].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=scattergeo].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scattergeo].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=scattergeo].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=scattergeo].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=scattergeo].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergeo].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scattergeo].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

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.

ids
Parent:
data[type=scattergeo]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

lat
Parent:
data[type=scattergeo]
Type:
data array

Sets the latitude coordinates (in degrees North).

legendgroup
Parent:
data[type=scattergeo]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scattergeo]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scattergeo].line
Type:
color

Sets the line color.

dash
Parent:
data[type=scattergeo].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=scattergeo].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

locationmode
Parent:
data[type=scattergeo]
Type:
enumerated , one of ( "ISO-3" | "USA-states" | "country names" )
Default:
"ISO-3"

Determines the set of locations used to match entries in `locations` to regions on the map.

locations
Parent:
data[type=scattergeo]
Type:
data array

Sets 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 array

Sets the longitude coordinates (in degrees East).

marker
Parent:
data[type=scattergeo]
Type:
object containing one or more of the keys listed below.
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.

autocolorscale
Parent:
data[type=scattergeo].marker
Type:
boolean
Default:
true

Determines 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:
true

Determines 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:
number

Sets 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:
number

Sets 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:
number

Sets 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 colors

Sets themarkercolor. 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:
subplotid

Sets 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.
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.

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:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scattergeo].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scattergeo].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=scattergeo].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.

nticks
Parent:
data[type=scattergeo].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=scattergeo].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scattergeo].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=scattergeo].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergeo].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=scattergeo].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scattergeo].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scattergeo].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scattergeo].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=scattergeo].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=scattergeo].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scattergeo].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=scattergeo].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=scattergeo].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=scattergeo].marker.colorbar
Type:
data array

Sets 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=scattergeo].marker.colorbar
Type:
data array

Sets 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=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=scattergeo].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=scattergeo].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scattergeo].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scattergeo].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergeo].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scattergeo].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scattergeo].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scattergeo].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scattergeo].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scattergeo].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scattergeo].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scattergeo].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scattergeo].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

gradient
Parent:
data[type=scattergeo].marker
Type:
object containing one or more of the keys listed below.
Default:
"none"

Sets the type of gradient used to fill the markers

color
Parent:
data[type=scattergeo].marker.gradient
Type:
color or array of colors

Sets 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=scattergeo].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

line
Parent:
data[type=scattergeo].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=scattergeo].marker.line
Type:
boolean
Default:
true

Determines 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=scattergeo].marker.line
Type:
boolean
Default:
true

Determines 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=scattergeo].marker.line
Type:
number

Sets 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=scattergeo].marker.line
Type:
number

Sets 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=scattergeo].marker.line
Type:
number

Sets 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=scattergeo].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=scattergeo].marker.line
Type:
subplotid

Sets 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=scattergeo].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scattergeo].marker.line
Type:
boolean

Reverses 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=scattergeo].marker.line
Type:
number or array of numbers greater than or equal to 0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=scattergeo].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scattergeo].marker
Type:
boolean

Reverses 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=scattergeo].marker
Type:
boolean

Determines 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=scattergeo].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scattergeo].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=scattergeo].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=scattergeo].marker
Type:
number
Default:
1

Has 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=scattergeo].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scattergeo]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scattergeo]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scattergeo]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scattergeo]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

selected
Parent:
data[type=scattergeo]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scattergeo].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scattergeo].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scattergeo].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scattergeo].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scattergeo].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scattergeo].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scattergeo]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scattergeo]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

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.

textfont
Parent:
data[type=scattergeo]
Type:
object containing one or more of the keys listed below.

Sets the text font.

color
Parent:
data[type=scattergeo].textfont
Type:
color or array of colors
family
Parent:
data[type=scattergeo].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattergeo].textfont
Type:
number or array of numbers greater than or equal to 1
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 appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon`, `location` and `text`.

type
Parent:
data[type=scattergeo]
Type:
"scattergeo"
uirevision
Parent:
data[type=scattergeo]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scattergeo]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scattergeo].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattergeo].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=scattergeo].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=scattergeo].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scattergeo].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattergeo].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scattergeo]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

29. Choropleth traces

A choropleth trace is an object with the key "type" equal to "choropleth" (i.e. {"type": "choropleth"}) and any of the keys listed below. The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`.

autocolorscale
Parent:
data[type=choropleth]
Type:
boolean
Default:
true

Determines 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.

coloraxis
Parent:
data[type=choropleth]
Type:
subplotid

Sets 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=choropleth]
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=choropleth].colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=choropleth].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=choropleth].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=choropleth].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=choropleth].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.

nticks
Parent:
data[type=choropleth].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=choropleth].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=choropleth].colorbar
Type:
boolean

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

showexponent
Parent:
data[type=choropleth].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=choropleth].colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=choropleth].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=choropleth].colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=choropleth].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=choropleth].colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=choropleth].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=choropleth].colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=choropleth].colorbar
Type:
object containing one or more of the keys listed below.

Sets the color bar's tick label font

color
Parent:
data[type=choropleth].colorbar.tickfont
Type:
color
family
Parent:
data[type=choropleth].colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=choropleth].colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=choropleth].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=choropleth].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=choropleth].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=choropleth].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=choropleth].colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=choropleth].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=choropleth].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=choropleth].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=choropleth].colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=choropleth].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=choropleth].colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=choropleth].colorbar
Type:
data array

Sets 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=choropleth].colorbar
Type:
data array

Sets 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=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=choropleth].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=choropleth].colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=choropleth].colorbar.title.font
Type:
color
family
Parent:
data[type=choropleth].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=choropleth].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=choropleth].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=choropleth].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=choropleth].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=choropleth].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=choropleth].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=choropleth].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=choropleth].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=choropleth]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=choropleth]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

geo
Parent:
data[type=choropleth]
Type:
subplotid
Default:
geo

Sets 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.

hoverinfo
Parent:
data[type=choropleth]
Type:
flaglist string. Any combination of "location", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=choropleth]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=choropleth].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=choropleth].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=choropleth].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=choropleth].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=choropleth].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=choropleth].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=choropleth].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=choropleth].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=choropleth]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=choropleth]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=choropleth]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

locationmode
Parent:
data[type=choropleth]
Type:
enumerated , one of ( "ISO-3" | "USA-states" | "country names" )
Default:
"ISO-3"

Determines the set of locations used to match entries in `locations` to regions on the map.

locations
Parent:
data[type=choropleth]
Type:
data array

Sets the coordinates via location IDs or names. See `locationmode` for more info.

marker
Parent:
data[type=choropleth]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets themarker.linecolor. 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.

line
Parent:
data[type=choropleth].marker
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets themarker.linecolor. 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.

color
Parent:
data[type=choropleth].marker.line
Type:
color or array of colors
Default:
"#444"

Sets themarker.linecolor. 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.

width
Parent:
data[type=choropleth].marker.line
Type:
number or array of numbers greater than or equal to 0
Default:
1

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=choropleth].marker
Type:
number or array of numbers between or equal to 0 and 1
Default:
1

Sets the opacity of the locations.

meta
Parent:
data[type=choropleth]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=choropleth]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

reversescale
Parent:
data[type=choropleth]
Type:
boolean

Reverses 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.

selected
Parent:
data[type=choropleth]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=choropleth].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

opacity
Parent:
data[type=choropleth].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

selectedpoints
Parent:
data[type=choropleth]
Type:
number or categorical coordinate string

Array 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.

showscale
Parent:
data[type=choropleth]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

text
Parent:
data[type=choropleth]
Type:
string or array of strings
Default:
""

Sets the text elements associated with each location.

type
Parent:
data[type=choropleth]
Type:
"choropleth"
uirevision
Parent:
data[type=choropleth]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=choropleth]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=choropleth].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=choropleth].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

visible
Parent:
data[type=choropleth]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z
Parent:
data[type=choropleth]
Type:
data array

Sets the color values.

zauto
Parent:
data[type=choropleth]
Type:
boolean
Default:
true

Determines 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.

zmax
Parent:
data[type=choropleth]
Type:
number

Sets 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=choropleth]
Type:
number

Sets 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=choropleth]
Type:
number

Sets 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.

30. Scattermapbox traces

A scattermapbox trace is an object with the key "type" equal to "scattermapbox" (i.e. {"type": "scattermapbox"}) and any of the keys listed below. The data visualized as scatter point, lines or marker symbols on a Mapbox GL geographic map is provided by longitude/latitude pairs in `lon` and `lat`.

below
Parent:
data[type=scattermapbox]
Type:
string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".

connectgaps
Parent:
data[type=scattermapbox]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scattermapbox]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

fill
Parent:
data[type=scattermapbox]
Type:
enumerated , one of ( "none" | "toself" )
Default:
"none"

Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

fillcolor
Parent:
data[type=scattermapbox]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo
Parent:
data[type=scattermapbox]
Type:
flaglist string. Any combination of "lon", "lat", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=scattermapbox]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=scattermapbox].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=scattermapbox].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scattermapbox].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=scattermapbox].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=scattermapbox].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=scattermapbox].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattermapbox].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scattermapbox].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=scattermapbox]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=scattermapbox]
Type:
string or array of strings
Default:
""

Sets hover text elements associated with each (lon,lat) 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 (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

ids
Parent:
data[type=scattermapbox]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

lat
Parent:
data[type=scattermapbox]
Type:
data array

Sets the latitude coordinates (in degrees North).

legendgroup
Parent:
data[type=scattermapbox]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scattermapbox]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scattermapbox].line
Type:
color

Sets the line color.

width
Parent:
data[type=scattermapbox].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

lon
Parent:
data[type=scattermapbox]
Type:
data array

Sets the longitude coordinates (in degrees East).

marker
Parent:
data[type=scattermapbox]
Type:
object containing one or more of the keys listed below.
Default:
"circle"

Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for "circle" symbols.

autocolorscale
Parent:
data[type=scattermapbox].marker
Type:
boolean
Default:
true

Determines 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=scattermapbox].marker
Type:
boolean
Default:
true

Determines 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=scattermapbox].marker
Type:
number

Sets 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=scattermapbox].marker
Type:
number

Sets 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=scattermapbox].marker
Type:
number

Sets 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=scattermapbox].marker
Type:
color or array of colors

Sets themarkercolor. 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=scattermapbox].marker
Type:
subplotid

Sets 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=scattermapbox].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=scattermapbox].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=scattermapbox].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scattermapbox].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=scattermapbox].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.

nticks
Parent:
data[type=scattermapbox].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=scattermapbox].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scattermapbox].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=scattermapbox].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattermapbox].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=scattermapbox].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scattermapbox].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scattermapbox].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scattermapbox].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=scattermapbox].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=scattermapbox].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scattermapbox].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=scattermapbox].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=scattermapbox].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=scattermapbox].marker.colorbar
Type:
data array

Sets 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=scattermapbox].marker.colorbar
Type:
data array

Sets 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=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=scattermapbox].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=scattermapbox].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scattermapbox].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scattermapbox].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattermapbox].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scattermapbox].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scattermapbox].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scattermapbox].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scattermapbox].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scattermapbox].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scattermapbox].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

opacity
Parent:
data[type=scattermapbox].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scattermapbox].marker
Type:
boolean

Reverses 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=scattermapbox].marker
Type:
boolean

Determines 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=scattermapbox].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scattermapbox].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=scattermapbox].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=scattermapbox].marker
Type:
number
Default:
1

Has 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=scattermapbox].marker
Type:
string or array of strings
Default:
"circle"

Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for "circle" symbols.

meta
Parent:
data[type=scattermapbox]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scattermapbox]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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.

name
Parent:
data[type=scattermapbox]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scattermapbox]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

selected
Parent:
data[type=scattermapbox]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scattermapbox].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scattermapbox].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scattermapbox].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scattermapbox].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

selectedpoints
Parent:
data[type=scattermapbox]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scattermapbox]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

subplot
Parent:
data[type=scattermapbox]
Type:
subplotid
Default:
mapbox

Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.

text
Parent:
data[type=scattermapbox]
Type:
string or array of strings
Default:
""

Sets text elements associated with each (lon,lat) 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 (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

textfont
Parent:
data[type=scattermapbox]
Type:
object containing one or more of the keys listed below.
Default:
"Open Sans Regular, Arial Unicode MS Regular"

Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol".

color
Parent:
data[type=scattermapbox].textfont
Type:
color
family
Parent:
data[type=scattermapbox].textfont
Type:
string
Default:
"Open Sans Regular, Arial Unicode MS Regular"

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattermapbox].textfont
Type:
number greater than or equal to 1
textposition
Parent:
data[type=scattermapbox]
Type:
enumerated , 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=scattermapbox]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `lat`, `lon` and `text`.

type
Parent:
data[type=scattermapbox]
Type:
"scattermapbox"
uirevision
Parent:
data[type=scattermapbox]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scattermapbox]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scattermapbox].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattermapbox].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=scattermapbox].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=scattermapbox].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scattermapbox]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

31. Choroplethmapbox traces

A choroplethmapbox trace is an object with the key "type" equal to "choroplethmapbox" (i.e. {"type": "choroplethmapbox"}) and any of the keys listed below. GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`.

autocolorscale
Parent:
data[type=choroplethmapbox]
Type:
boolean
Default:
true

Determines 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.

below
Parent:
data[type=choroplethmapbox]
Type:
string

Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.

coloraxis
Parent:
data[type=choroplethmapbox]
Type:
subplotid

Sets 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=choroplethmapbox]
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=choroplethmapbox].colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=choroplethmapbox].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=choroplethmapbox].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=choroplethmapbox].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=choroplethmapbox].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.

nticks
Parent:
data[type=choroplethmapbox].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=choroplethmapbox].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=choroplethmapbox].colorbar
Type:
boolean

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

showexponent
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=choroplethmapbox].colorbar
Type:
object containing one or more of the keys listed below.

Sets the color bar's tick label font

color
Parent:
data[type=choroplethmapbox].colorbar.tickfont
Type:
color
family
Parent:
data[type=choroplethmapbox].colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=choroplethmapbox].colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=choroplethmapbox].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=choroplethmapbox].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=choroplethmapbox].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=choroplethmapbox].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=choroplethmapbox].colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=choroplethmapbox].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=choroplethmapbox].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=choroplethmapbox].colorbar
Type:
data array

Sets 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=choroplethmapbox].colorbar
Type:
data array

Sets 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=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=choroplethmapbox].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=choroplethmapbox].colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=choroplethmapbox].colorbar.title.font
Type:
color
family
Parent:
data[type=choroplethmapbox].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=choroplethmapbox].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=choroplethmapbox].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=choroplethmapbox].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=choroplethmapbox].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=choroplethmapbox].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=choroplethmapbox].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=choroplethmapbox].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=choroplethmapbox].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=choroplethmapbox]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=choroplethmapbox]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

geojson
Parent:
data[type=choroplethmapbox]
Type:
number or categorical coordinate string

Sets the GeoJSON data associated with this trace. Can be set as a valid GeoJSON object or as URL string Note that we only accept GeoJSON of type "FeatureCollection" and "Feature" with geometries of type "Polygon" and "MultiPolygon".

hoverinfo
Parent:
data[type=choroplethmapbox]
Type:
flaglist string. Any combination of "location", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=choroplethmapbox]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=choroplethmapbox].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=choroplethmapbox].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=choroplethmapbox].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=choroplethmapbox].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=choroplethmapbox].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=choroplethmapbox].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=choroplethmapbox].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=choroplethmapbox].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=choroplethmapbox]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `properties` 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>`.

hovertext
Parent:
data[type=choroplethmapbox]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=choroplethmapbox]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

locations
Parent:
data[type=choroplethmapbox]
Type:
data array

Sets which features found in "geojson" to plot using their feature `id` field.

marker
Parent:
data[type=choroplethmapbox]
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets themarker.linecolor. 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.

line
Parent:
data[type=choroplethmapbox].marker
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets themarker.linecolor. 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.

color
Parent:
data[type=choroplethmapbox].marker.line
Type:
color or array of colors
Default:
"#444"

Sets themarker.linecolor. 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.

width
Parent:
data[type=choroplethmapbox].marker.line
Type:
number or array of numbers greater than or equal to 0
Default:
1

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=choroplethmapbox].marker
Type:
number or array of numbers between or equal to 0 and 1
Default:
1

Sets the opacity of the locations.

meta
Parent:
data[type=choroplethmapbox]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=choroplethmapbox]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

reversescale
Parent:
data[type=choroplethmapbox]
Type:
boolean

Reverses 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.

selected
Parent:
data[type=choroplethmapbox]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=choroplethmapbox].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

opacity
Parent:
data[type=choroplethmapbox].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

selectedpoints
Parent:
data[type=choroplethmapbox]
Type:
number or categorical coordinate string

Array 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.

showscale
Parent:
data[type=choroplethmapbox]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

subplot
Parent:
data[type=choroplethmapbox]
Type:
subplotid
Default:
mapbox

Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.

text
Parent:
data[type=choroplethmapbox]
Type:
string or array of strings
Default:
""

Sets the text elements associated with each location.

type
Parent:
data[type=choroplethmapbox]
Type:
"choroplethmapbox"
uirevision
Parent:
data[type=choroplethmapbox]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=choroplethmapbox]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=choroplethmapbox].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=choroplethmapbox].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

visible
Parent:
data[type=choroplethmapbox]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z
Parent:
data[type=choroplethmapbox]
Type:
data array

Sets the color values.

zauto
Parent:
data[type=choroplethmapbox]
Type:
boolean
Default:
true

Determines 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.

zmax
Parent:
data[type=choroplethmapbox]
Type:
number

Sets 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=choroplethmapbox]
Type:
number

Sets 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=choroplethmapbox]
Type:
number

Sets 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.

32. Densitymapbox traces

A densitymapbox trace is an object with the key "type" equal to "densitymapbox" (i.e. {"type": "densitymapbox"}) and any of the keys listed below. Draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale.

autocolorscale
Parent:
data[type=densitymapbox]
Type:
boolean
Default:
true

Determines 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.

below
Parent:
data[type=densitymapbox]
Type:
string

Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.

coloraxis
Parent:
data[type=densitymapbox]
Type:
subplotid

Sets 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=densitymapbox]
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=densitymapbox].colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=densitymapbox].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=densitymapbox].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=densitymapbox].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=densitymapbox].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.

nticks
Parent:
data[type=densitymapbox].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=densitymapbox].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=densitymapbox].colorbar
Type:
boolean

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

showexponent
Parent:
data[type=densitymapbox].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=densitymapbox].colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=densitymapbox].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=densitymapbox].colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=densitymapbox].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=densitymapbox].colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=densitymapbox].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=densitymapbox].colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=densitymapbox].colorbar
Type:
object containing one or more of the keys listed below.

Sets the color bar's tick label font

color
Parent:
data[type=densitymapbox].colorbar.tickfont
Type:
color
family
Parent:
data[type=densitymapbox].colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=densitymapbox].colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=densitymapbox].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=densitymapbox].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=densitymapbox].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=densitymapbox].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=densitymapbox].colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=densitymapbox].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=densitymapbox].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=densitymapbox].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=densitymapbox].colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=densitymapbox].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=densitymapbox].colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=densitymapbox].colorbar
Type:
data array

Sets 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=densitymapbox].colorbar
Type:
data array

Sets 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=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=densitymapbox].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=densitymapbox].colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=densitymapbox].colorbar.title.font
Type:
color
family
Parent:
data[type=densitymapbox].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=densitymapbox].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=densitymapbox].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=densitymapbox].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=densitymapbox].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=densitymapbox].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=densitymapbox].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=densitymapbox].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=densitymapbox].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=densitymapbox]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

customdata
Parent:
data[type=densitymapbox]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

hoverinfo
Parent:
data[type=densitymapbox]
Type:
flaglist string. Any combination of "lon", "lat", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=densitymapbox]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=densitymapbox].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=densitymapbox].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=densitymapbox].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=densitymapbox].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=densitymapbox].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=densitymapbox].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=densitymapbox].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=densitymapbox].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=densitymapbox]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=densitymapbox]
Type:
string or array of strings
Default:
""

Sets hover text elements associated with each (lon,lat) 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 (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

ids
Parent:
data[type=densitymapbox]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

lat
Parent:
data[type=densitymapbox]
Type:
data array

Sets the latitude coordinates (in degrees North).

lon
Parent:
data[type=densitymapbox]
Type:
data array

Sets the longitude coordinates (in degrees East).

meta
Parent:
data[type=densitymapbox]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=densitymapbox]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=densitymapbox]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

radius
Parent:
data[type=densitymapbox]
Type:
number or array of numbers greater than or equal to 1
Default:
30

Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

reversescale
Parent:
data[type=densitymapbox]
Type:
boolean

Reverses 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.

showscale
Parent:
data[type=densitymapbox]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

subplot
Parent:
data[type=densitymapbox]
Type:
subplotid
Default:
mapbox

Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.

text
Parent:
data[type=densitymapbox]
Type:
string or array of strings
Default:
""

Sets text elements associated with each (lon,lat) 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 (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

type
Parent:
data[type=densitymapbox]
Type:
"densitymapbox"
uirevision
Parent:
data[type=densitymapbox]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=densitymapbox]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z
Parent:
data[type=densitymapbox]
Type:
data array

Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

zauto
Parent:
data[type=densitymapbox]
Type:
boolean
Default:
true

Determines 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.

zmax
Parent:
data[type=densitymapbox]
Type:
number

Sets 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=densitymapbox]
Type:
number

Sets 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=densitymapbox]
Type:
number

Sets 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.

33. Scatterpolar traces

A scatterpolar trace is an object with the key "type" equal to "scatterpolar" (i.e. {"type": "scatterpolar"}) and any of the keys listed below. The scatterpolar trace type encompasses line charts, scatter charts, text charts, and bubble charts in polar coordinates. The data visualized as scatter point or lines is set in `r` (radial) and `theta` (angular) coordinates 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.

cliponaxis
Parent:
data[type=scatterpolar]
Type:
boolean

Determines 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=scatterpolar]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scatterpolar]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dr
Parent:
data[type=scatterpolar]
Type:
number
Default:
1

Sets the r coordinate step.

dtheta
Parent:
data[type=scatterpolar]
Type:
number

Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.

fill
Parent:
data[type=scatterpolar]
Type:
enumerated , one of ( "none" | "toself" | "tonext" )
Default:
"none"

Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterpolar has a subset of the options available to scatter. "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.

fillcolor
Parent:
data[type=scatterpolar]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo
Parent:
data[type=scatterpolar]
Type:
flaglist string. Any combination of "r", "theta", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=scatterpolar]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=scatterpolar].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=scatterpolar].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scatterpolar].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=scatterpolar].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=scatterpolar].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=scatterpolar].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolar].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scatterpolar].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoveron
Parent:
data[type=scatterpolar]
Type:
flaglist string. Any combination of "points", "fills" joined with a "+"

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".

hovertemplate
Parent:
data[type=scatterpolar]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=scatterpolar]
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.

ids
Parent:
data[type=scatterpolar]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scatterpolar]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scatterpolar]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scatterpolar].line
Type:
color

Sets the line color.

dash
Parent:
data[type=scatterpolar].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=scatterpolar].line
Type:
enumerated , one of ( "linear" | "spline" )
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.

smoothing
Parent:
data[type=scatterpolar].line
Type:
number between or equal to 0 and 1.3
Default:
1

Has 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=scatterpolar].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

marker
Parent:
data[type=scatterpolar]
Type:
object containing one or more of the keys listed below.
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.

autocolorscale
Parent:
data[type=scatterpolar].marker
Type:
boolean
Default:
true

Determines 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=scatterpolar].marker
Type:
boolean
Default:
true

Determines 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=scatterpolar].marker
Type:
number

Sets 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=scatterpolar].marker
Type:
number

Sets 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=scatterpolar].marker
Type:
number

Sets 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=scatterpolar].marker
Type:
color or array of colors

Sets themarkercolor. 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=scatterpolar].marker
Type:
subplotid

Sets 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=scatterpolar].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=scatterpolar].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=scatterpolar].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scatterpolar].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=scatterpolar].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.

nticks
Parent:
data[type=scatterpolar].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=scatterpolar].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scatterpolar].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=scatterpolar].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolar].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=scatterpolar].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scatterpolar].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scatterpolar].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scatterpolar].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=scatterpolar].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=scatterpolar].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scatterpolar].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=scatterpolar].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=scatterpolar].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=scatterpolar].marker.colorbar
Type:
data array

Sets 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=scatterpolar].marker.colorbar
Type:
data array

Sets 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=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=scatterpolar].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=scatterpolar].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scatterpolar].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scatterpolar].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolar].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scatterpolar].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scatterpolar].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scatterpolar].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scatterpolar].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scatterpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scatterpolar].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

gradient
Parent:
data[type=scatterpolar].marker
Type:
object containing one or more of the keys listed below.
Default:
"none"

Sets the type of gradient used to fill the markers

color
Parent:
data[type=scatterpolar].marker.gradient
Type:
color or array of colors

Sets 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=scatterpolar].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

line
Parent:
data[type=scatterpolar].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=scatterpolar].marker.line
Type:
boolean
Default:
true

Determines 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=scatterpolar].marker.line
Type:
boolean
Default:
true

Determines 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=scatterpolar].marker.line
Type:
number

Sets 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=scatterpolar].marker.line
Type:
number

Sets 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=scatterpolar].marker.line
Type:
number

Sets 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=scatterpolar].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=scatterpolar].marker.line
Type:
subplotid

Sets 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=scatterpolar].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scatterpolar].marker.line
Type:
boolean

Reverses 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=scatterpolar].marker.line
Type:
number or array of numbers greater than or equal to 0

Sets the width (in px) of the lines bounding the marker points.

maxdisplayed
Parent:
data[type=scatterpolar].marker
Type:
number greater than or equal to 0
Default:
0

Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

opacity
Parent:
data[type=scatterpolar].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scatterpolar].marker
Type:
boolean

Reverses 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=scatterpolar].marker
Type:
boolean

Determines 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=scatterpolar].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scatterpolar].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=scatterpolar].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=scatterpolar].marker
Type:
number
Default:
1

Has 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=scatterpolar].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scatterpolar]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scatterpolar]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scatterpolar]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scatterpolar]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

r0
Parent:
data[type=scatterpolar]
Type:
number or categorical coordinate string
Default:
0

Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.

selected
Parent:
data[type=scatterpolar]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scatterpolar].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scatterpolar].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scatterpolar].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scatterpolar].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scatterpolar].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scatterpolar].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scatterpolar]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scatterpolar]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

subplot
Parent:
data[type=scatterpolar]
Type:
subplotid
Default:
polar

Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on.

text
Parent:
data[type=scatterpolar]
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.

textfont
Parent:
data[type=scatterpolar]
Type:
object containing one or more of the keys listed below.

Sets the text font.

color
Parent:
data[type=scatterpolar].textfont
Type:
color or array of colors
family
Parent:
data[type=scatterpolar].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolar].textfont
Type:
number or array of numbers greater than or equal to 1
textposition
Parent:
data[type=scatterpolar]
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=scatterpolar]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`.

theta
Parent:
data[type=scatterpolar]
Type:
data array

Sets the angular coordinates

theta0
Parent:
data[type=scatterpolar]
Type:
number or categorical coordinate string
Default:
0

Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.

thetaunit
Parent:
data[type=scatterpolar]
Type:
enumerated , one of ( "radians" | "degrees" | "gradians" )
Default:
"degrees"

Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes.

type
Parent:
data[type=scatterpolar]
Type:
"scatterpolar"
uirevision
Parent:
data[type=scatterpolar]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scatterpolar]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scatterpolar].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatterpolar].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=scatterpolar].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=scatterpolar].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scatterpolar].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatterpolar].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scatterpolar]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

34. Scatterpolargl traces

A scatterpolargl trace is an object with the key "type" equal to "scatterpolargl" (i.e. {"type": "scatterpolargl"}) and any of the keys listed below. The scatterpolargl trace type encompasses line charts, scatter charts, and bubble charts in polar coordinates using the WebGL plotting engine. The data visualized as scatter point or lines is set in `r` (radial) and `theta` (angular) coordinates Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays.

connectgaps
Parent:
data[type=scatterpolargl]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scatterpolargl]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dr
Parent:
data[type=scatterpolargl]
Type:
number
Default:
1

Sets the r coordinate step.

dtheta
Parent:
data[type=scatterpolargl]
Type:
number

Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.

fill
Parent:
data[type=scatterpolargl]
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=scatterpolargl]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo
Parent:
data[type=scatterpolargl]
Type:
flaglist string. Any combination of "r", "theta", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=scatterpolargl]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=scatterpolargl].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=scatterpolargl].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scatterpolargl].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=scatterpolargl].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=scatterpolargl].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=scatterpolargl].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolargl].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scatterpolargl].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=scatterpolargl]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=scatterpolargl]
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.

ids
Parent:
data[type=scatterpolargl]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scatterpolargl]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scatterpolargl]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scatterpolargl].line
Type:
color

Sets the line color.

dash
Parent:
data[type=scatterpolargl].line
Type:
enumerated , one of ( "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
Default:
"solid"

Sets the style of the lines.

shape
Parent:
data[type=scatterpolargl].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=scatterpolargl].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

marker
Parent:
data[type=scatterpolargl]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets themarkercolor. 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.

autocolorscale
Parent:
data[type=scatterpolargl].marker
Type:
boolean
Default:
true

Determines 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=scatterpolargl].marker
Type:
boolean
Default:
true

Determines 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=scatterpolargl].marker
Type:
number

Sets 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=scatterpolargl].marker
Type:
number

Sets 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=scatterpolargl].marker
Type:
number

Sets 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=scatterpolargl].marker
Type:
color or array of colors

Sets themarkercolor. 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=scatterpolargl].marker
Type:
subplotid

Sets 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=scatterpolargl].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=scatterpolargl].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.

nticks
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=scatterpolargl].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolargl].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=scatterpolargl].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scatterpolargl].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scatterpolargl].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=scatterpolargl].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=scatterpolargl].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scatterpolargl].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=scatterpolargl].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=scatterpolargl].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
data array

Sets 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=scatterpolargl].marker.colorbar
Type:
data array

Sets 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=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=scatterpolargl].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scatterpolargl].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scatterpolargl].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolargl].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scatterpolargl].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scatterpolargl].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scatterpolargl].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scatterpolargl].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=scatterpolargl].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets themarker.linecolor. 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.

autocolorscale
Parent:
data[type=scatterpolargl].marker.line
Type:
boolean
Default:
true

Determines 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=scatterpolargl].marker.line
Type:
boolean
Default:
true

Determines 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=scatterpolargl].marker.line
Type:
number

Sets 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=scatterpolargl].marker.line
Type:
number

Sets 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=scatterpolargl].marker.line
Type:
number

Sets 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=scatterpolargl].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=scatterpolargl].marker.line
Type:
subplotid

Sets 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=scatterpolargl].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scatterpolargl].marker.line
Type:
boolean

Reverses 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=scatterpolargl].marker.line
Type:
number or array of numbers greater than or equal to 0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=scatterpolargl].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scatterpolargl].marker
Type:
boolean

Reverses 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=scatterpolargl].marker
Type:
boolean

Determines 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=scatterpolargl].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scatterpolargl].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=scatterpolargl].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=scatterpolargl].marker
Type:
number
Default:
1

Has 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=scatterpolargl].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scatterpolargl]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scatterpolargl]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scatterpolargl]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scatterpolargl]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

r0
Parent:
data[type=scatterpolargl]
Type:
number or categorical coordinate string
Default:
0

Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.

selected
Parent:
data[type=scatterpolargl]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scatterpolargl].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scatterpolargl].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scatterpolargl].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scatterpolargl].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scatterpolargl].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scatterpolargl].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scatterpolargl]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scatterpolargl]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

subplot
Parent:
data[type=scatterpolargl]
Type:
subplotid
Default:
polar

Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on.

text
Parent:
data[type=scatterpolargl]
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.

textfont
Parent:
data[type=scatterpolargl]
Type:
object containing one or more of the keys listed below.

Sets the text font.

color
Parent:
data[type=scatterpolargl].textfont
Type:
color or array of colors
family
Parent:
data[type=scatterpolargl].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterpolargl].textfont
Type:
number or array of numbers greater than or equal to 1
textposition
Parent:
data[type=scatterpolargl]
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=scatterpolargl]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `r`, `theta` and `text`.

theta
Parent:
data[type=scatterpolargl]
Type:
data array

Sets the angular coordinates

theta0
Parent:
data[type=scatterpolargl]
Type:
number or categorical coordinate string
Default:
0

Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.

thetaunit
Parent:
data[type=scatterpolargl]
Type:
enumerated , one of ( "radians" | "degrees" | "gradians" )
Default:
"degrees"

Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes.

type
Parent:
data[type=scatterpolargl]
Type:
"scatterpolargl"
uirevision
Parent:
data[type=scatterpolargl]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scatterpolargl]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scatterpolargl].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatterpolargl].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=scatterpolargl].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=scatterpolargl].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scatterpolargl].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatterpolargl].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scatterpolargl]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

35. Barpolar traces

A barpolar trace is an object with the key "type" equal to "barpolar" (i.e. {"type": "barpolar"}) and any of the keys listed below. The data visualized by the radial span of the bars is set in `r`

base
Parent:
data[type=barpolar]
Type:
number or categorical coordinate string

Sets where the bar base is drawn (in radial axis units). In "stack" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead.

customdata
Parent:
data[type=barpolar]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dr
Parent:
data[type=barpolar]
Type:
number
Default:
1

Sets the r coordinate step.

dtheta
Parent:
data[type=barpolar]
Type:
number

Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.

hoverinfo
Parent:
data[type=barpolar]
Type:
flaglist string. Any combination of "r", "theta", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=barpolar]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=barpolar].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=barpolar].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=barpolar].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=barpolar].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=barpolar].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=barpolar].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=barpolar].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=barpolar].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=barpolar]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=barpolar]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=barpolar]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=barpolar]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=barpolar]
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=barpolar].marker
Type:
boolean
Default:
true

Determines 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=barpolar].marker
Type:
boolean
Default:
true

Determines 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=barpolar].marker
Type:
number

Sets 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=barpolar].marker
Type:
number

Sets 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=barpolar].marker
Type:
number

Sets 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=barpolar].marker
Type:
color or array of colors

Sets themarkercolor. 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=barpolar].marker
Type:
subplotid

Sets 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=barpolar].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=barpolar].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=barpolar].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=barpolar].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=barpolar].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=barpolar].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.

nticks
Parent:
data[type=barpolar].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=barpolar].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=barpolar].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=barpolar].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=barpolar].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=barpolar].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=barpolar].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=barpolar].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=barpolar].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=barpolar].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=barpolar].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=barpolar].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=barpolar].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=barpolar].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=barpolar].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=barpolar].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=barpolar].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=barpolar].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=barpolar].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=barpolar].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=barpolar].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=barpolar].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=barpolar].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=barpolar].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=barpolar].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=barpolar].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=barpolar].marker.colorbar
Type:
data array

Sets 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=barpolar].marker.colorbar
Type:
data array

Sets 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=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=barpolar].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=barpolar].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=barpolar].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=barpolar].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=barpolar].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=barpolar].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=barpolar].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=barpolar].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=barpolar].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=barpolar].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=barpolar].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=barpolar].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=barpolar].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=barpolar].marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=barpolar].marker.line
Type:
boolean
Default:
true

Determines 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=barpolar].marker.line
Type:
boolean
Default:
true

Determines 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=barpolar].marker.line
Type:
number

Sets 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=barpolar].marker.line
Type:
number

Sets 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=barpolar].marker.line
Type:
number

Sets 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=barpolar].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=barpolar].marker.line
Type:
subplotid

Sets 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=barpolar].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=barpolar].marker.line
Type:
boolean

Reverses 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=barpolar].marker.line
Type:
number or array of numbers greater than or equal to 0
Default:
0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=barpolar].marker
Type:
number or array of numbers between or equal to 0 and 1
Default:
1

Sets the opacity of the bars.

reversescale
Parent:
data[type=barpolar].marker
Type:
boolean

Reverses 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=barpolar].marker
Type:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

meta
Parent:
data[type=barpolar]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=barpolar]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

offset
Parent:
data[type=barpolar]
Type:
number or array of numbers

Shifts the angular position where the bar is drawn (in "thetatunit" units).

opacity
Parent:
data[type=barpolar]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

r0
Parent:
data[type=barpolar]
Type:
number or categorical coordinate string
Default:
0

Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.

selected
Parent:
data[type=barpolar]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=barpolar].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=barpolar].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=barpolar].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

textfont
Parent:
data[type=barpolar].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=barpolar].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=barpolar]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=barpolar]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

subplot
Parent:
data[type=barpolar]
Type:
subplotid
Default:
polar

Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on.

text
Parent:
data[type=barpolar]
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.

theta
Parent:
data[type=barpolar]
Type:
data array

Sets the angular coordinates

theta0
Parent:
data[type=barpolar]
Type:
number or categorical coordinate string
Default:
0

Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.

thetaunit
Parent:
data[type=barpolar]
Type:
enumerated , one of ( "radians" | "degrees" | "gradians" )
Default:
"degrees"

Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes.

type
Parent:
data[type=barpolar]
Type:
"barpolar"
uirevision
Parent:
data[type=barpolar]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=barpolar]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=barpolar].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=barpolar].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=barpolar].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=barpolar].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=barpolar].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=barpolar]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width
Parent:
data[type=barpolar]
Type:
number or array of numbers greater than or equal to 0

Sets the bar angular width (in "thetaunit" units).

36. Scatterternary traces

A scatterternary trace is an object with the key "type" equal to "scatterternary" (i.e. {"type": "scatterternary"}) and any of the keys listed below. Provides similar functionality to the "scatter" type but on a ternary phase diagram. The data is provided by at least two arrays out of `a`, `b`, `c` triplets.

a
Parent:
data[type=scatterternary]
Type:
data array

Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.

b
Parent:
data[type=scatterternary]
Type:
data array

Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.

c
Parent:
data[type=scatterternary]
Type:
data array

Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.

cliponaxis
Parent:
data[type=scatterternary]
Type:
boolean
Default:
true

Determines 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=scatterternary]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scatterternary]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

fill
Parent:
data[type=scatterternary]
Type:
enumerated , one of ( "none" | "toself" | "tonext" )
Default:
"none"

Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "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.

fillcolor
Parent:
data[type=scatterternary]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo
Parent:
data[type=scatterternary]
Type:
flaglist string. Any combination of "a", "b", "c", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=scatterternary]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=scatterternary].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=scatterternary].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scatterternary].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=scatterternary].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=scatterternary].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=scatterternary].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterternary].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scatterternary].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoveron
Parent:
data[type=scatterternary]
Type:
flaglist string. Any combination of "points", "fills" joined with a "+"

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".

hovertemplate
Parent:
data[type=scatterternary]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=scatterternary]
Type:
string or array of strings
Default:
""

Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a "text" flag.

ids
Parent:
data[type=scatterternary]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scatterternary]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scatterternary]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scatterternary].line
Type:
color

Sets the line color.

dash
Parent:
data[type=scatterternary].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=scatterternary].line
Type:
enumerated , one of ( "linear" | "spline" )
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.

smoothing
Parent:
data[type=scatterternary].line
Type:
number between or equal to 0 and 1.3
Default:
1

Has 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=scatterternary].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

marker
Parent:
data[type=scatterternary]
Type:
object containing one or more of the keys listed below.
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.

autocolorscale
Parent:
data[type=scatterternary].marker
Type:
boolean
Default:
true

Determines 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=scatterternary].marker
Type:
boolean
Default:
true

Determines 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=scatterternary].marker
Type:
number

Sets 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=scatterternary].marker
Type:
number

Sets 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=scatterternary].marker
Type:
number

Sets 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=scatterternary].marker
Type:
color or array of colors

Sets themarkercolor. 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=scatterternary].marker
Type:
subplotid

Sets 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=scatterternary].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=scatterternary].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=scatterternary].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scatterternary].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scatterternary].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=scatterternary].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.

nticks
Parent:
data[type=scatterternary].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=scatterternary].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scatterternary].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=scatterternary].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterternary].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=scatterternary].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scatterternary].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scatterternary].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scatterternary].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=scatterternary].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=scatterternary].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scatterternary].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=scatterternary].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=scatterternary].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=scatterternary].marker.colorbar
Type:
data array

Sets 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=scatterternary].marker.colorbar
Type:
data array

Sets 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=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=scatterternary].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=scatterternary].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scatterternary].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scatterternary].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterternary].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scatterternary].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scatterternary].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scatterternary].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scatterternary].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scatterternary].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scatterternary].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scatterternary].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scatterternary].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

gradient
Parent:
data[type=scatterternary].marker
Type:
object containing one or more of the keys listed below.
Default:
"none"

Sets the type of gradient used to fill the markers

color
Parent:
data[type=scatterternary].marker.gradient
Type:
color or array of colors

Sets 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=scatterternary].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

line
Parent:
data[type=scatterternary].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=scatterternary].marker.line
Type:
boolean
Default:
true

Determines 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=scatterternary].marker.line
Type:
boolean
Default:
true

Determines 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=scatterternary].marker.line
Type:
number

Sets 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=scatterternary].marker.line
Type:
number

Sets 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=scatterternary].marker.line
Type:
number

Sets 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=scatterternary].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=scatterternary].marker.line
Type:
subplotid

Sets 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=scatterternary].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scatterternary].marker.line
Type:
boolean

Reverses 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=scatterternary].marker.line
Type:
number or array of numbers greater than or equal to 0

Sets the width (in px) of the lines bounding the marker points.

maxdisplayed
Parent:
data[type=scatterternary].marker
Type:
number greater than or equal to 0
Default:
0

Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

opacity
Parent:
data[type=scatterternary].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scatterternary].marker
Type:
boolean

Reverses 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=scatterternary].marker
Type:
boolean

Determines 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=scatterternary].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scatterternary].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=scatterternary].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=scatterternary].marker
Type:
number
Default:
1

Has 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=scatterternary].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scatterternary]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scatterternary]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scatterternary]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scatterternary]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

selected
Parent:
data[type=scatterternary]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scatterternary].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scatterternary].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scatterternary].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scatterternary].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scatterternary].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scatterternary].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scatterternary]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scatterternary]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

subplot
Parent:
data[type=scatterternary]
Type:
subplotid
Default:
ternary

Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default value), the data refer to `layout.ternary`. If "ternary2", the data refer to `layout.ternary2`, and so on.

sum
Parent:
data[type=scatterternary]
Type:
number greater than or equal to 0
Default:
0

The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary<i>.sum` to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sum

text
Parent:
data[type=scatterternary]
Type:
string or array of strings
Default:
""

Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

textfont
Parent:
data[type=scatterternary]
Type:
object containing one or more of the keys listed below.

Sets the text font.

color
Parent:
data[type=scatterternary].textfont
Type:
color or array of colors
family
Parent:
data[type=scatterternary].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scatterternary].textfont
Type:
number or array of numbers greater than or equal to 1
textposition
Parent:
data[type=scatterternary]
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=scatterternary]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b`, `c` and `text`.

type
Parent:
data[type=scatterternary]
Type:
"scatterternary"
uirevision
Parent:
data[type=scatterternary]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scatterternary]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scatterternary].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatterternary].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=scatterternary].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=scatterternary].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scatterternary].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scatterternary].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scatterternary]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

37. Sunburst traces

A sunburst trace is an object with the key "type" equal to "sunburst" (i.e. {"type": "sunburst"}) and any of the keys listed below. Visualize hierarchal data spanning outward radially from root to leaves. The sunburst sectors are determined by the entries in "labels" or "ids" and in "parents".

branchvalues
Parent:
data[type=sunburst]
Type:
enumerated , one of ( "remainder" | "total" )
Default:
"remainder"

Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

count
Parent:
data[type=sunburst]
Type:
flaglist string. Any combination of "branches", "leaves" joined with a "+"
Default:
"leaves"

Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0.

customdata
Parent:
data[type=sunburst]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

domain
Parent:
data[type=sunburst]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this sunburst trace (in plot fraction).

column
Parent:
data[type=sunburst].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this sunburst trace .

row
Parent:
data[type=sunburst].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this sunburst trace .

x
Parent:
data[type=sunburst].domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this sunburst trace (in plot fraction).

y
Parent:
data[type=sunburst].domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this sunburst trace (in plot fraction).

hoverinfo
Parent:
data[type=sunburst]
Type:
flaglist string. Any combination of "label", "text", "value", "name", "current path", "percent root", "percent entry", "percent parent" joined with a "+" OR "all" or "none" or "skip".
Default:
"label+text+value+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.

hoverlabel
Parent:
data[type=sunburst]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=sunburst].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=sunburst].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=sunburst].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=sunburst].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=sunburst].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=sunburst].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sunburst].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=sunburst].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=sunburst]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. 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>`.

hovertext
Parent:
data[type=sunburst]
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.

ids
Parent:
data[type=sunburst]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

insidetextfont
Parent:
data[type=sunburst]
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=sunburst].insidetextfont
Type:
color or array of colors
family
Parent:
data[type=sunburst].insidetextfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sunburst].insidetextfont
Type:
number or array of numbers greater than or equal to 1
labels
Parent:
data[type=sunburst]
Type:
data array

Sets the labels of each of the sectors.

leaf
Parent:
data[type=sunburst]
Type:
object containing one or more of the keys listed below.

Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7

opacity
Parent:
data[type=sunburst].leaf
Type:
number between or equal to 0 and 1

Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7

level
Parent:
data[type=sunburst]
Type:
number or categorical coordinate string

Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.

marker
Parent:
data[type=sunburst]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

autocolorscale
Parent:
data[type=sunburst].marker
Type:
boolean
Default:
true

Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if colorsis 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=sunburst].marker
Type:
boolean
Default:
true

Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if colorsis set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.

cmax
Parent:
data[type=sunburst].marker
Type:
number

Sets the upper bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmin` must be set as well.

cmid
Parent:
data[type=sunburst].marker
Type:
number

Sets 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 colorsis set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `false`.

cmin
Parent:
data[type=sunburst].marker
Type:
number

Sets the lower bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmax` must be set as well.

coloraxis
Parent:
data[type=sunburst].marker
Type:
subplotid

Sets 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=sunburst].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=sunburst].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=sunburst].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=sunburst].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=sunburst].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=sunburst].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.

nticks
Parent:
data[type=sunburst].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=sunburst].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=sunburst].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=sunburst].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=sunburst].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=sunburst].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=sunburst].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=sunburst].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=sunburst].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=sunburst].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=sunburst].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=sunburst].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=sunburst].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=sunburst].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sunburst].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=sunburst].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=sunburst].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=sunburst].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=sunburst].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=sunburst].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=sunburst].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=sunburst].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=sunburst].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=sunburst].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=sunburst].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=sunburst].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=sunburst].marker.colorbar
Type:
data array

Sets 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=sunburst].marker.colorbar
Type:
data array

Sets 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=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=sunburst].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=sunburst].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=sunburst].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=sunburst].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sunburst].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=sunburst].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=sunburst].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=sunburst].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=sunburst].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=sunburst].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=sunburst].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=sunburst].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colors
Parent:
data[type=sunburst].marker
Type:
data array

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

colorscale
Parent:
data[type=sunburst].marker
Type:
colorscale

Sets the colorscale. Has an effect only if colorsis 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=sunburst].marker
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

color
Parent:
data[type=sunburst].marker.line
Type:
color or array of colors

Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

width
Parent:
data[type=sunburst].marker.line
Type:
number or array of numbers greater than or equal to 0
Default:
1

Sets the width (in px) of the line enclosing each sector.

reversescale
Parent:
data[type=sunburst].marker
Type:
boolean

Reverses the color mapping if true. Has an effect only if colorsis 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=sunburst].marker
Type:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if colorsis set to a numerical array.

maxdepth
Parent:
data[type=sunburst]
Type:
integer
Default:
-1

Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy.

meta
Parent:
data[type=sunburst]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=sunburst]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=sunburst]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

outsidetextfont
Parent:
data[type=sunburst]
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=sunburst].outsidetextfont
Type:
color or array of colors
family
Parent:
data[type=sunburst].outsidetextfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sunburst].outsidetextfont
Type:
number or array of numbers greater than or equal to 1
parents
Parent:
data[type=sunburst]
Type:
data array

Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.

text
Parent:
data[type=sunburst]
Type:
data array

Sets 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.

textfont
Parent:
data[type=sunburst]
Type:
object containing one or more of the keys listed below.

Sets the font used for `textinfo`.

color
Parent:
data[type=sunburst].textfont
Type:
color or array of colors
family
Parent:
data[type=sunburst].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sunburst].textfont
Type:
number or array of numbers greater than or equal to 1
textinfo
Parent:
data[type=sunburst]
Type:
flaglist string. Any combination of "label", "text", "value", "current path", "percent root", "percent entry", "percent parent" joined with a "+" OR "none".

Determines which trace information appear on the graph.

texttemplate
Parent:
data[type=sunburst]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.

type
Parent:
data[type=sunburst]
Type:
"sunburst"
uirevision
Parent:
data[type=sunburst]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

values
Parent:
data[type=sunburst]
Type:
data array

Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed.

visible
Parent:
data[type=sunburst]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

38. Treemap traces

A treemap trace is an object with the key "type" equal to "treemap" (i.e. {"type": "treemap"}) and any of the keys listed below. Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The treemap sectors are determined by the entries in "labels" or "ids" and in "parents".

branchvalues
Parent:
data[type=treemap]
Type:
enumerated , one of ( "remainder" | "total" )
Default:
"remainder"

Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

count
Parent:
data[type=treemap]
Type:
flaglist string. Any combination of "branches", "leaves" joined with a "+"
Default:
"leaves"

Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0.

customdata
Parent:
data[type=treemap]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

domain
Parent:
data[type=treemap]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this treemap trace (in plot fraction).

column
Parent:
data[type=treemap].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this treemap trace .

row
Parent:
data[type=treemap].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this treemap trace .

x
Parent:
data[type=treemap].domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this treemap trace (in plot fraction).

y
Parent:
data[type=treemap].domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this treemap trace (in plot fraction).

hoverinfo
Parent:
data[type=treemap]
Type:
flaglist string. Any combination of "label", "text", "value", "name", "current path", "percent root", "percent entry", "percent parent" joined with a "+" OR "all" or "none" or "skip".
Default:
"label+text+value+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.

hoverlabel
Parent:
data[type=treemap]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=treemap].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=treemap].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=treemap].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=treemap].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=treemap].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=treemap].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=treemap].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=treemap]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. 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>`.

hovertext
Parent:
data[type=treemap]
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.

ids
Parent:
data[type=treemap]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

insidetextfont
Parent:
data[type=treemap]
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=treemap].insidetextfont
Type:
color or array of colors
family
Parent:
data[type=treemap].insidetextfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].insidetextfont
Type:
number or array of numbers greater than or equal to 1
labels
Parent:
data[type=treemap]
Type:
data array

Sets the labels of each of the sectors.

level
Parent:
data[type=treemap]
Type:
number or categorical coordinate string

Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.

marker
Parent:
data[type=treemap]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the padding form the top (in px).

autocolorscale
Parent:
data[type=treemap].marker
Type:
boolean
Default:
true

Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if colorsis 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=treemap].marker
Type:
boolean
Default:
true

Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if colorsis set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.

cmax
Parent:
data[type=treemap].marker
Type:
number

Sets the upper bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmin` must be set as well.

cmid
Parent:
data[type=treemap].marker
Type:
number

Sets 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 colorsis set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `false`.

cmin
Parent:
data[type=treemap].marker
Type:
number

Sets the lower bound of the color domain. Has an effect only if colorsis set to a numerical array. Value should have the same units as colors and if set, `marker.cmax` must be set as well.

coloraxis
Parent:
data[type=treemap].marker
Type:
subplotid

Sets 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=treemap].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=treemap].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=treemap].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=treemap].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=treemap].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=treemap].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.

nticks
Parent:
data[type=treemap].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=treemap].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=treemap].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=treemap].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=treemap].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=treemap].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=treemap].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=treemap].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=treemap].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=treemap].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=treemap].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=treemap].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=treemap].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=treemap].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=treemap].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=treemap].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=treemap].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=treemap].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=treemap].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=treemap].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=treemap].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=treemap].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=treemap].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=treemap].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=treemap].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=treemap].marker.colorbar
Type:
data array

Sets 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=treemap].marker.colorbar
Type:
data array

Sets 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=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=treemap].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=treemap].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=treemap].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=treemap].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=treemap].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=treemap].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=treemap].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=treemap].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=treemap].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=treemap].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=treemap].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colors
Parent:
data[type=treemap].marker
Type:
data array

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

colorscale
Parent:
data[type=treemap].marker
Type:
colorscale

Sets the colorscale. Has an effect only if colorsis 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

depthfade
Parent:
data[type=treemap].marker
Type:
enumerated , one of ( true | false | "reversed" )

Determines if the sector colors are faded towards the background from the leaves up to the headers. This option is unavailable when a `colorscale` is present, defaults to false when `marker.colors` is set, but otherwise defaults to true. When set to "reversed", the fading direction is inverted, that is the top elements within hierarchy are drawn with fully saturated colors while the leaves are faded towards the background color.

line
Parent:
data[type=treemap].marker
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

color
Parent:
data[type=treemap].marker.line
Type:
color or array of colors

Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

width
Parent:
data[type=treemap].marker.line
Type:
number or array of numbers greater than or equal to 0
Default:
1

Sets the width (in px) of the line enclosing each sector.

pad
Parent:
data[type=treemap].marker
Type:
object containing one or more of the keys listed below.

Sets the padding form the top (in px).

b
Parent:
data[type=treemap].marker.pad
Type:
number greater than or equal to 0

Sets the padding form the bottom (in px).

l
Parent:
data[type=treemap].marker.pad
Type:
number greater than or equal to 0

Sets the padding form the left (in px).

t
Parent:
data[type=treemap].marker.pad
Type:
number greater than or equal to 0

Sets the padding form the top (in px).

reversescale
Parent:
data[type=treemap].marker
Type:
boolean

Reverses the color mapping if true. Has an effect only if colorsis 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=treemap].marker
Type:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if colorsis set to a numerical array.

maxdepth
Parent:
data[type=treemap]
Type:
integer
Default:
-1

Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy.

meta
Parent:
data[type=treemap]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=treemap]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=treemap]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

outsidetextfont
Parent:
data[type=treemap]
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=treemap].outsidetextfont
Type:
color or array of colors
family
Parent:
data[type=treemap].outsidetextfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].outsidetextfont
Type:
number or array of numbers greater than or equal to 1
parents
Parent:
data[type=treemap]
Type:
data array

Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.

pathbar
Parent:
data[type=treemap]
Type:
object containing one or more of the keys listed below.
Default:
true

Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap.

edgeshape
Parent:
data[type=treemap].pathbar
Type:
enumerated , one of ( "&gt;" | "&lt;" | "|" | "/" | "\" )
Default:
"&gt;"

Determines which shape is used for edges between `barpath` labels.

side
Parent:
data[type=treemap].pathbar
Type:
enumerated , one of ( "top" | "bottom" )
Default:
"top"

Determines on which side of the the treemap the `pathbar` should be presented.

textfont
Parent:
data[type=treemap].pathbar
Type:
object containing one or more of the keys listed below.

Sets the font used inside `pathbar`.

color
Parent:
data[type=treemap].pathbar.textfont
Type:
color or array of colors
family
Parent:
data[type=treemap].pathbar.textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].pathbar.textfont
Type:
number or array of numbers greater than or equal to 1
thickness
Parent:
data[type=treemap].pathbar
Type:
number greater than or equal to 12

Sets the thickness of `pathbar` (in px). If not specified the `pathbar.textfont.size` is used with 3 pixles extra padding on each side.

visible
Parent:
data[type=treemap].pathbar
Type:
boolean
Default:
true

Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap.

text
Parent:
data[type=treemap]
Type:
data array

Sets 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.

textfont
Parent:
data[type=treemap]
Type:
object containing one or more of the keys listed below.

Sets the font used for `textinfo`.

color
Parent:
data[type=treemap].textfont
Type:
color or array of colors
family
Parent:
data[type=treemap].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=treemap].textfont
Type:
number or array of numbers greater than or equal to 1
textinfo
Parent:
data[type=treemap]
Type:
flaglist string. Any combination of "label", "text", "value", "current path", "percent root", "percent entry", "percent parent" joined with a "+" OR "none".

Determines which trace information appear on the graph.

textposition
Parent:
data[type=treemap]
Type:
enumerated , one of ( "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
Default:
"top left"

Sets the positions of the `text` elements.

texttemplate
Parent:
data[type=treemap]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.

tiling
Parent:
data[type=treemap]
Type:
object containing one or more of the keys listed below.
Default:
"squarify"

Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap-tiling

flip
Parent:
data[type=treemap].tiling
Type:
flaglist string. Any combination of "x", "y" joined with a "+"
Default:
""

Determines if the positions obtained from solver are flipped on each axis.

packing
Parent:
data[type=treemap].tiling
Type:
enumerated , one of ( "squarify" | "binary" | "dice" | "slice" | "slice-dice" | "dice-slice" )
Default:
"squarify"

Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap-tiling

pad
Parent:
data[type=treemap].tiling
Type:
number greater than or equal to 0
Default:
3

Sets the inner padding (in px).

squarifyratio
Parent:
data[type=treemap].tiling
Type:
number greater than or equal to 1
Default:
1

When using "squarify" `packing` algorithm, according to https://github.com/d3/d3-hierarchy/blob/master/README.md#squarify_ratio this option specifies the desired aspect ratio of the generated rectangles. The ratio must be specified as a number greater than or equal to one. Note that the orientation of the generated rectangles (tall or wide) is not implied by the ratio; for example, a ratio of two will attempt to produce a mixture of rectangles whose width:height ratio is either 2:1 or 1:2. When using "squarify", unlike d3 which uses the Golden Ratio i.e. 1.618034, Plotly applies 1 to increase squares in treemap layouts.

type
Parent:
data[type=treemap]
Type:
"treemap"
uirevision
Parent:
data[type=treemap]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

values
Parent:
data[type=treemap]
Type:
data array

Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed.

visible
Parent:
data[type=treemap]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

39. Sankey traces

A sankey trace is an object with the key "type" equal to "sankey" (i.e. {"type": "sankey"}) and any of the keys listed below. Sankey plots for network flow data analysis. The nodes are specified in `nodes` and the links between sources and targets in `links`. The colors are set in `nodes[i].color` and `links[i].color`, otherwise defaults are used.

arrangement
Parent:
data[type=sankey]
Type:
enumerated , one of ( "snap" | "perpendicular" | "freeform" | "fixed" )
Default:
"snap"

If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary.

customdata
Parent:
data[type=sankey]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

domain
Parent:
data[type=sankey]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this sankey trace (in plot fraction).

column
Parent:
data[type=sankey].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this sankey trace .

row
Parent:
data[type=sankey].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this sankey trace .

x
Parent:
data[type=sankey].domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this sankey trace (in plot fraction).

y
Parent:
data[type=sankey].domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this sankey trace (in plot fraction).

hoverinfo
Parent:
data[type=sankey]
Type:
flaglist string. Any combination of joined with a "+" OR "all" or "none" or "skip".
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. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively.

hoverlabel
Parent:
data[type=sankey]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=sankey].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=sankey].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=sankey].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=sankey].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=sankey].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=sankey].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sankey].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=sankey].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

ids
Parent:
data[type=sankey]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

link
Parent:
data[type=sankey]
Type:
object containing one or more of the keys listed below.

The links of the Sankey plot.

color
Parent:
data[type=sankey].link
Type:
color or array of colors

Sets the `link` color. It can be a single value, or an array for specifying color for each `link`. If `link.color` is omitted, then by default, a translucent grey link will be used.

colorscales
Parent:
data[type=sankey].link
Type:
array of object where each object has one or more of the keys listed below.
Default:
""

The label of the links to color based on their concentration within a flow.

cmax
Parent:
data[type=sankey].link.colorscales[]
Type:
number
Default:
1

Sets the upper bound of the color domain.

cmin
Parent:
data[type=sankey].link.colorscales[]
Type:
number
Default:
0

Sets the lower bound of the color domain.

colorscale
Parent:
data[type=sankey].link.colorscales[]
Type:
colorscale
Default:
[[0, white], [1, black], ]

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

label
Parent:
data[type=sankey].link.colorscales[]
Type:
string
Default:
""

The label of the links to color based on their concentration within a flow.

name
Parent:
data[type=sankey].link.colorscales[]
Type:
string

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

templateitemname
Parent:
data[type=sankey].link.colorscales[]
Type:
string

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

hoverinfo
Parent:
data[type=sankey].link
Type:
enumerated , one of ( "all" | "none" | "skip" )
Default:
"all"

Determines which trace information appear when hovering links. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

hoverlabel
Parent:
data[type=sankey].link
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=sankey].link.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=sankey].link.hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=sankey].link.hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=sankey].link.hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=sankey].link.hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=sankey].link.hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sankey].link.hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=sankey].link.hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=sankey].link
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

label
Parent:
data[type=sankey].link
Type:
data array

The shown name of the link.

line
Parent:
data[type=sankey].link
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the color of the `line` around each `link`.

color
Parent:
data[type=sankey].link.line
Type:
color or array of colors
Default:
"#444"

Sets the color of the `line` around each `link`.

width
Parent:
data[type=sankey].link.line
Type:
number or array of numbers greater than or equal to 0
Default:
0

Sets the width (in px) of the `line` around each `link`.

source
Parent:
data[type=sankey].link
Type:
data array

An integer number `[0..nodes.length - 1]` that represents the source node.

target
Parent:
data[type=sankey].link
Type:
data array

An integer number `[0..nodes.length - 1]` that represents the target node.

value
Parent:
data[type=sankey].link
Type:
data array

A numeric value representing the flow volume value.

meta
Parent:
data[type=sankey]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=sankey]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

node
Parent:
data[type=sankey]
Type:
object containing one or more of the keys listed below.

The nodes of the Sankey plot.

color
Parent:
data[type=sankey].node
Type:
color or array of colors

Sets the `node` color. It can be a single value, or an array for specifying color for each `node`. If `node.color` is omitted, then the default `Plotly` color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.

groups
Parent:
data[type=sankey].node
Type:
array
Default:
[]

Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.

hoverinfo
Parent:
data[type=sankey].node
Type:
enumerated , one of ( "all" | "none" | "skip" )
Default:
"all"

Determines which trace information appear when hovering nodes. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

hoverlabel
Parent:
data[type=sankey].node
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=sankey].node.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=sankey].node.hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=sankey].node.hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=sankey].node.hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=sankey].node.hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=sankey].node.hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sankey].node.hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=sankey].node.hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=sankey].node
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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>`.

label
Parent:
data[type=sankey].node
Type:
data array

The shown name of the node.

line
Parent:
data[type=sankey].node
Type:
object containing one or more of the keys listed below.
Default:
"#444"

Sets the color of the `line` around each `node`.

color
Parent:
data[type=sankey].node.line
Type:
color or array of colors
Default:
"#444"

Sets the color of the `line` around each `node`.

width
Parent:
data[type=sankey].node.line
Type:
number or array of numbers greater than or equal to 0
Default:
0.5

Sets the width (in px) of the `line` around each `node`.

pad
Parent:
data[type=sankey].node
Type:
number greater than or equal to 0
Default:
20

Sets the padding (in px) between the `nodes`.

thickness
Parent:
data[type=sankey].node
Type:
number greater than or equal to 1
Default:
20

Sets the thickness (in px) of the `nodes`.

x
Parent:
data[type=sankey].node
Type:
data array

The normalized horizontal position of the node.

y
Parent:
data[type=sankey].node
Type:
data array

The normalized vertical position of the node.

orientation
Parent:
data[type=sankey]
Type:
enumerated , one of ( "v" | "h" )
Default:
"h"

Sets the orientation of the Sankey diagram.

selectedpoints
Parent:
data[type=sankey]
Type:
number or categorical coordinate string

Array 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.

textfont
Parent:
data[type=sankey]
Type:
object containing one or more of the keys listed below.

Sets the font for node labels

color
Parent:
data[type=sankey].textfont
Type:
color
family
Parent:
data[type=sankey].textfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=sankey].textfont
Type:
number greater than or equal to 1
type
Parent:
data[type=sankey]
Type:
"sankey"
uirevision
Parent:
data[type=sankey]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

valueformat
Parent:
data[type=sankey]
Type:
string
Default:
".3s"

Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

valuesuffix
Parent:
data[type=sankey]
Type:
string
Default:
""

Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

visible
Parent:
data[type=sankey]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

40. Splom traces

A splom trace is an object with the key "type" equal to "splom" (i.e. {"type": "splom"}) and any of the keys listed below. Splom traces generate scatter plot matrix visualizations. Each splom `dimensions` items correspond to a generated axis. Values for each of those dimensions are set in `dimensions[i].values`. Splom traces support all `scattergl` marker style attributes. Specify `layout.grid` attributes and/or layout x-axis and y-axis attributes for more control over the axis positioning and style.

customdata
Parent:
data[type=splom]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

diagonal
Parent:
data[type=splom]
Type:
object containing one or more of the keys listed below.
Default:
true

Determines whether or not subplots on the diagonal are displayed.

visible
Parent:
data[type=splom].diagonal
Type:
boolean
Default:
true

Determines whether or not subplots on the diagonal are displayed.

dimensions
Parent:
data[type=splom]
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this dimension is shown on the graph. Note that even visible false dimension contribute to the default grid generate by this splom trace.

axis
Parent:
data[type=splom].dimensions[]
Type:
object containing one or more of the keys listed below.

Sets the axis type for this dimension's generated x and y axes. Note that the axis `type` values set in layout take precedence over this attribute.

matches
Parent:
data[type=splom].dimensions[].axis
Type:
boolean

Determines whether or not the x & y axes generated by this dimension match. Equivalent to setting the `matches` axis attribute in the layout with the correct axis id.

type
Parent:
data[type=splom].dimensions[].axis
Type:
enumerated , one of ( "linear" | "log" | "date" | "category" )

Sets the axis type for this dimension's generated x and y axes. Note that the axis `type` values set in layout take precedence over this attribute.

label
Parent:
data[type=splom].dimensions[]
Type:
string

Sets the label corresponding to this splom dimension.

name
Parent:
data[type=splom].dimensions[]
Type:
string

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

templateitemname
Parent:
data[type=splom].dimensions[]
Type:
string

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

values
Parent:
data[type=splom].dimensions[]
Type:
data array

Sets the dimension values to be plotted.

visible
Parent:
data[type=splom].dimensions[]
Type:
boolean
Default:
true

Determines whether or not this dimension is shown on the graph. Note that even visible false dimension contribute to the default grid generate by this splom trace.

hoverinfo
Parent:
data[type=splom]
Type:
flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=splom]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=splom].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=splom].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=splom].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=splom].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=splom].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=splom].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=splom].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=splom].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hovertemplate
Parent:
data[type=splom]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=splom]
Type:
string or array of strings
Default:
""

Same as `text`.

ids
Parent:
data[type=splom]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=splom]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=splom]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets themarkercolor. 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.

autocolorscale
Parent:
data[type=splom].marker
Type:
boolean
Default:
true

Determines 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=splom].marker
Type:
boolean
Default:
true

Determines 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=splom].marker
Type:
number

Sets 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=splom].marker
Type:
number

Sets 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=splom].marker
Type:
number

Sets 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=splom].marker
Type:
color or array of colors

Sets themarkercolor. 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=splom].marker
Type:
subplotid

Sets 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=splom].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=splom].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=splom].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=splom].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=splom].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=splom].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.

nticks
Parent:
data[type=splom].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=splom].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=splom].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=splom].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=splom].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=splom].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=splom].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=splom].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=splom].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=splom].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=splom].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=splom].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=splom].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=splom].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=splom].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=splom].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=splom].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=splom].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=splom].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=splom].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=splom].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=splom].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=splom].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=splom].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=splom].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=splom].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=splom].marker.colorbar
Type:
data array

Sets 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=splom].marker.colorbar
Type:
data array

Sets 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=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=splom].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=splom].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=splom].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=splom].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=splom].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=splom].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=splom].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=splom].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=splom].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=splom].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=splom].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=splom].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=splom].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

line
Parent:
data[type=splom].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets themarker.linecolor. 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.

autocolorscale
Parent:
data[type=splom].marker.line
Type:
boolean
Default:
true

Determines 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=splom].marker.line
Type:
boolean
Default:
true

Determines 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=splom].marker.line
Type:
number

Sets 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=splom].marker.line
Type:
number

Sets 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=splom].marker.line
Type:
number

Sets 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=splom].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=splom].marker.line
Type:
subplotid

Sets 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=splom].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=splom].marker.line
Type:
boolean

Reverses 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=splom].marker.line
Type:
number or array of numbers greater than or equal to 0

Sets the width (in px) of the lines bounding the marker points.

opacity
Parent:
data[type=splom].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=splom].marker
Type:
boolean

Reverses 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=splom].marker
Type:
boolean

Determines 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=splom].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=splom].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=splom].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=splom].marker
Type:
number
Default:
1

Has 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=splom].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=splom]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=splom]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=splom]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

selected
Parent:
data[type=splom]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=splom].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=splom].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=splom].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=splom].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

selectedpoints
Parent:
data[type=splom]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=splom]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

showlowerhalf
Parent:
data[type=splom]
Type:
boolean
Default:
true

Determines whether or not subplots on the lower half from the diagonal are displayed.

showupperhalf
Parent:
data[type=splom]
Type:
boolean
Default:
true

Determines whether or not subplots on the upper half from the diagonal are displayed.

text
Parent:
data[type=splom]
Type:
string or array of strings
Default:
""

Sets text elements associated with each (x,y) pair to appear on hover. 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.

type
Parent:
data[type=splom]
Type:
"splom"
uirevision
Parent:
data[type=splom]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=splom]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=splom].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=splom].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=splom].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=splom].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

visible
Parent:
data[type=splom]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

xaxes
Parent:
data[type=splom]
Type:
array

Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis.

yaxes
Parent:
data[type=splom]
Type:
array

Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is false and `showupperhalf` or `showlowerhalf` is false, this splom trace will generate one less x-axis and one less y-axis.

41. Parcoords traces

A parcoords trace is an object with the key "type" equal to "parcoords" (i.e. {"type": "parcoords"}) and any of the keys listed below. Parallel coordinates for multidimensional exploratory data analysis. The samples are specified in `dimensions`. The colors are set in `line.color`.

customdata
Parent:
data[type=parcoords]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

dimensions
Parent:
data[type=parcoords]
Type:
array of object where each object has one or more of the keys listed below.
Default:
""

The shown name of the dimension.

constraintrange
Parent:
data[type=parcoords].dimensions[]
Type:
array

The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`.

label
Parent:
data[type=parcoords].dimensions[]
Type:
string

The shown name of the dimension.

multiselect
Parent:
data[type=parcoords].dimensions[]
Type:
boolean
Default:
true

Do we allow multiple selection ranges or just a single range?

name
Parent:
data[type=parcoords].dimensions[]
Type:
string

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

range
Parent:
data[type=parcoords].dimensions[]
Type:
array

The domain range that represents the full, shown axis extent. Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements.

templateitemname
Parent:
data[type=parcoords].dimensions[]
Type:
string

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

tickformat
Parent:
data[type=parcoords].dimensions[]
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

ticktext
Parent:
data[type=parcoords].dimensions[]
Type:
data array

Sets the text displayed at the ticks position via `tickvals`.

tickvals
Parent:
data[type=parcoords].dimensions[]
Type:
data array

Sets the values at which ticks on this axis appear.

values
Parent:
data[type=parcoords].dimensions[]
Type:
data array

Dimension values. `values[n]` represents the value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated). Each value must be a finite number.

visible
Parent:
data[type=parcoords].dimensions[]
Type:
boolean
Default:
true

Shows the dimension when set to `true` (the default). Hides the dimension for `false`.

domain
Parent:
data[type=parcoords]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this parcoords trace (in plot fraction).

column
Parent:
data[type=parcoords].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this parcoords trace .

row
Parent:
data[type=parcoords].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this parcoords trace .

x
Parent:
data[type=parcoords].domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this parcoords trace (in plot fraction).

y
Parent:
data[type=parcoords].domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this parcoords trace (in plot fraction).

ids
Parent:
data[type=parcoords]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

labelangle
Parent:
data[type=parcoords]
Type:
angle
Default:
0

Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom".

labelfont
Parent:
data[type=parcoords]
Type:
object containing one or more of the keys listed below.

Sets the font for the `dimension` labels.

color
Parent:
data[type=parcoords].labelfont
Type:
color
family
Parent:
data[type=parcoords].labelfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcoords].labelfont
Type:
number greater than or equal to 1
labelside
Parent:
data[type=parcoords]
Type:
enumerated , one of ( "top" | "bottom" )
Default:
"top"

Specifies the location of the `label`. "top" positions labels above, next to the title "bottom" positions labels below the graph Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom".

line
Parent:
data[type=parcoords]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets thelinecolor. 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.

autocolorscale
Parent:
data[type=parcoords].line
Type:
boolean

Determines 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=parcoords].line
Type:
boolean
Default:
true

Determines 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=parcoords].line
Type:
number

Sets 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=parcoords].line
Type:
number

Sets 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=parcoords].line
Type:
number

Sets 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=parcoords].line
Type:
color or array of colors

Sets thelinecolor. 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=parcoords].line
Type:
subplotid

Sets 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=parcoords].line
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=parcoords].line.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=parcoords].line.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=parcoords].line.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=parcoords].line.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=parcoords].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.

nticks
Parent:
data[type=parcoords].line.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=parcoords].line.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=parcoords].line.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=parcoords].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=parcoords].line.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=parcoords].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=parcoords].line.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=parcoords].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=parcoords].line.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=parcoords].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=parcoords].line.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=parcoords].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=parcoords].line.colorbar.tickfont
Type:
color
family
Parent:
data[type=parcoords].line.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcoords].line.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=parcoords].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=parcoords].line.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=parcoords].line.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=parcoords].line.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=parcoords].line.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=parcoords].line.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=parcoords].line.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=parcoords].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=parcoords].line.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=parcoords].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=parcoords].line.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=parcoords].line.colorbar
Type:
data array

Sets 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=parcoords].line.colorbar
Type:
data array

Sets 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=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=parcoords].line.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=parcoords].line.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=parcoords].line.colorbar.title.font
Type:
color
family
Parent:
data[type=parcoords].line.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcoords].line.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=parcoords].line.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=parcoords].line.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=parcoords].line.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=parcoords].line.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=parcoords].line.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=parcoords].line.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=parcoords].line.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=parcoords].line
Type:
colorscale
Default:
[[0, #440154], [0.06274509803921569, #48186a], [0.12549019607843137, #472d7b], [0.18823529411764706, #424086], [0.25098039215686274, #3b528b], [0.3137254901960784, #33638d], [0.3764705882352941, #2c728e], [0.4392156862745098, #26828e], [0.5019607843137255, #21918c], [0.5647058823529412, #1fa088], [0.6274509803921569, #28ae80], [0.6901960784313725, #3fbc73], [0.7529411764705882, #5ec962], [0.8156862745098039, #84d44b], [0.8784313725490196, #addc30], [0.9411764705882353, #d8e219], [1, #fde725], ]

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=parcoords].line
Type:
boolean

Reverses 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=parcoords].line
Type:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array.

meta
Parent:
data[type=parcoords]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=parcoords]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

rangefont
Parent:
data[type=parcoords]
Type:
object containing one or more of the keys listed below.

Sets the font for the `dimension` range values.

color
Parent:
data[type=parcoords].rangefont
Type:
color
family
Parent:
data[type=parcoords].rangefont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcoords].rangefont
Type:
number greater than or equal to 1
tickfont
Parent:
data[type=parcoords]
Type:
object containing one or more of the keys listed below.

Sets the font for the `dimension` tick values.

color
Parent:
data[type=parcoords].tickfont
Type:
color
family
Parent:
data[type=parcoords].tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcoords].tickfont
Type:
number greater than or equal to 1
type
Parent:
data[type=parcoords]
Type:
"parcoords"
uirevision
Parent:
data[type=parcoords]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=parcoords]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

42. Parcats traces

A parcats trace is an object with the key "type" equal to "parcats" (i.e. {"type": "parcats"}) and any of the keys listed below. Parallel categories diagram for multidimensional categorical data.

arrangement
Parent:
data[type=parcats]
Type:
enumerated , one of ( "perpendicular" | "freeform" | "fixed" )
Default:
"perpendicular"

Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary.

bundlecolors
Parent:
data[type=parcats]
Type:
boolean
Default:
true

Sort paths so that like colors are bundled together within each category.

counts
Parent:
data[type=parcats]
Type:
number or array of numbers greater than or equal to 0
Default:
1

The number of observations represented by each state. Defaults to 1 so that each state represents one observation

dimensions
Parent:
data[type=parcats]
Type:
array of object where each object has one or more of the keys listed below.
Default:
"trace"

The shown name of the dimension.

categoryarray
Parent:
data[type=parcats].dimensions[]
Type:
data array

Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
data[type=parcats].dimensions[]
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" )
Default:
"trace"

Specifies the ordering logic for the categories in the dimension. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.

displayindex
Parent:
data[type=parcats].dimensions[]
Type:
integer

The display index of dimension, from left to right, zero indexed, defaults to dimension index.

label
Parent:
data[type=parcats].dimensions[]
Type:
string

The shown name of the dimension.

ticktext
Parent:
data[type=parcats].dimensions[]
Type:
data array

Sets alternative tick labels for the categories in this dimension. Only has an effect if `categoryorder` is set to "array". Should be an array the same length as `categoryarray` Used with `categoryorder`.

values
Parent:
data[type=parcats].dimensions[]
Type:
data array

Dimension values. `values[n]` represents the category value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated).

visible
Parent:
data[type=parcats].dimensions[]
Type:
boolean
Default:
true

Shows the dimension when set to `true` (the default). Hides the dimension for `false`.

domain
Parent:
data[type=parcats]
Type:
object containing one or more of the keys listed below.
Default:
[0, 1]

Sets the horizontal domain of this parcats trace (in plot fraction).

column
Parent:
data[type=parcats].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this column in the grid for this parcats trace .

row
Parent:
data[type=parcats].domain
Type:
integer greater than or equal to 0
Default:
0

If there is a layout grid, use the domain for this row in the grid for this parcats trace .

x
Parent:
data[type=parcats].domain
Type:
array
Default:
[0, 1]

Sets the horizontal domain of this parcats trace (in plot fraction).

y
Parent:
data[type=parcats].domain
Type:
array
Default:
[0, 1]

Sets the vertical domain of this parcats trace (in plot fraction).

hoverinfo
Parent:
data[type=parcats]
Type:
flaglist string. Any combination of "count", "probability" joined with a "+" OR "all" or "none" or "skip".
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.

hoveron
Parent:
data[type=parcats]
Type:
enumerated , one of ( "category" | "color" | "dimension" )
Default:
"category"

Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension.

hovertemplate
Parent:
data[type=parcats]
Type:
string
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. 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>`.

labelfont
Parent:
data[type=parcats]
Type:
object containing one or more of the keys listed below.

Sets the font for the `dimension` labels.

color
Parent:
data[type=parcats].labelfont
Type:
color
family
Parent:
data[type=parcats].labelfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcats].labelfont
Type:
number greater than or equal to 1
line
Parent:
data[type=parcats]
Type:
object containing one or more of the keys listed below.
Default:
true

Sets thelinecolor. 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.

autocolorscale
Parent:
data[type=parcats].line
Type:
boolean
Default:
true

Determines 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=parcats].line
Type:
boolean
Default:
true

Determines 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=parcats].line
Type:
number

Sets 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=parcats].line
Type:
number

Sets 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=parcats].line
Type:
number

Sets 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=parcats].line
Type:
color or array of colors

Sets thelinecolor. 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=parcats].line
Type:
subplotid

Sets 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=parcats].line
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=parcats].line.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=parcats].line.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=parcats].line.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=parcats].line.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=parcats].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.

nticks
Parent:
data[type=parcats].line.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=parcats].line.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=parcats].line.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=parcats].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=parcats].line.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=parcats].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=parcats].line.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=parcats].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=parcats].line.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=parcats].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=parcats].line.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=parcats].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=parcats].line.colorbar.tickfont
Type:
color
family
Parent:
data[type=parcats].line.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcats].line.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=parcats].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=parcats].line.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=parcats].line.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=parcats].line.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=parcats].line.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=parcats].line.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=parcats].line.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=parcats].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=parcats].line.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=parcats].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=parcats].line.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=parcats].line.colorbar
Type:
data array

Sets 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=parcats].line.colorbar
Type:
data array

Sets 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=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=parcats].line.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=parcats].line.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=parcats].line.colorbar.title.font
Type:
color
family
Parent:
data[type=parcats].line.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcats].line.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=parcats].line.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=parcats].line.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=parcats].line.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=parcats].line.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=parcats].line.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=parcats].line.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=parcats].line.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=parcats].line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

hovertemplate
Parent:
data[type=parcats].line
Type:
string
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `count` and `probability`. 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>`.

reversescale
Parent:
data[type=parcats].line
Type:
boolean

Reverses 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.

shape
Parent:
data[type=parcats].line
Type:
enumerated , one of ( "linear" | "hspline" )
Default:
"linear"

Sets the shape of the paths. If `linear`, paths are composed of straight lines. If `hspline`, paths are composed of horizontal curved splines

showscale
Parent:
data[type=parcats].line
Type:
boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array.

meta
Parent:
data[type=parcats]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=parcats]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

sortpaths
Parent:
data[type=parcats]
Type:
enumerated , one of ( "forward" | "backward" )
Default:
"forward"

Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left.

tickfont
Parent:
data[type=parcats]
Type:
object containing one or more of the keys listed below.

Sets the font for the `category` labels.

color
Parent:
data[type=parcats].tickfont
Type:
color
family
Parent:
data[type=parcats].tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=parcats].tickfont
Type:
number greater than or equal to 1
type
Parent:
data[type=parcats]
Type:
"parcats"
uirevision
Parent:
data[type=parcats]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=parcats]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

43. Carpet traces

A carpet trace is an object with the key "type" equal to "carpet" (i.e. {"type": "carpet"}) and any of the keys listed below. The data describing carpet axis layout is set in `y` and (optionally) also `x`. If only `y` is present, `x` the plot is interpreted as a cheater plot and is filled in using the `y` values. `x` and `y` may either be 2D arrays matching with each dimension matching that of `a` and `b`, or they may be 1D arrays with total length equal to that of `a` and `b`.

a
Parent:
data[type=carpet]
Type:
data array

An array containing values of the first parameter value

a0
Parent:
data[type=carpet]
Type:
number
Default:
0

Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step.

aaxis
Parent:
data[type=carpet]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

arraydtick
Parent:
data[type=carpet].aaxis
Type:
integer greater than or equal to 1
Default:
1

The stride between grid lines along the axis

arraytick0
Parent:
data[type=carpet].aaxis
Type:
integer greater than or equal to 0
Default:
0

The starting index of grid lines along the axis

autorange
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

categoryarray
Parent:
data[type=carpet].aaxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.

cheatertype
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "index" | "value" )
Default:
"value"
color
Parent:
data[type=carpet].aaxis
Type:
color

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
data[type=carpet].aaxis
Type:
number greater than or equal to 0
Default:
1

The stride between grid lines along the axis

endline
Parent:
data[type=carpet].aaxis
Type:
boolean

Determines whether or not a line is drawn at along the final value of this axis. If "true", the end line is drawn on top of the grid lines.

endlinecolor
Parent:
data[type=carpet].aaxis
Type:
color

Sets the line color of the end line.

endlinewidth
Parent:
data[type=carpet].aaxis
Type:
number
Default:
1

Sets the width (in px) of the end line.

exponentformat
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

fixedrange
Parent:
data[type=carpet].aaxis
Type:
boolean

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

gridcolor
Parent:
data[type=carpet].aaxis
Type:
color

Sets the axis line color.

gridwidth
Parent:
data[type=carpet].aaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

labelpadding
Parent:
data[type=carpet].aaxis
Type:
integer
Default:
10

Extra padding between label and the axis

labelprefix
Parent:
data[type=carpet].aaxis
Type:
string

Sets a axis label prefix.

labelsuffix
Parent:
data[type=carpet].aaxis
Type:
string
Default:
""

Sets a axis label suffix.

linecolor
Parent:
data[type=carpet].aaxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
data[type=carpet].aaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

minorgridcolor
Parent:
data[type=carpet].aaxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

minorgridcount
Parent:
data[type=carpet].aaxis
Type:
integer greater than or equal to 0
Default:
0

Sets the number of minor grid ticks per major grid tick

minorgridwidth
Parent:
data[type=carpet].aaxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

nticks
Parent:
data[type=carpet].aaxis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
data[type=carpet].aaxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.

separatethousands
Parent:
data[type=carpet].aaxis
Type:
boolean

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

showexponent
Parent:
data[type=carpet].aaxis
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.

showgrid
Parent:
data[type=carpet].aaxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
data[type=carpet].aaxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "start" | "end" | "both" | "none" )
Default:
"start"

Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

showtickprefix
Parent:
data[type=carpet].aaxis
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=carpet].aaxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

smoothing
Parent:
data[type=carpet].aaxis
Type:
number between or equal to 0 and 1.3
Default:
1
startline
Parent:
data[type=carpet].aaxis
Type:
boolean

Determines whether or not a line is drawn at along the starting value of this axis. If "true", the start line is drawn on top of the grid lines.

startlinecolor
Parent:
data[type=carpet].aaxis
Type:
color

Sets the line color of the start line.

startlinewidth
Parent:
data[type=carpet].aaxis
Type:
number
Default:
1

Sets the width (in px) of the start line.

tick0
Parent:
data[type=carpet].aaxis
Type:
number greater than or equal to 0
Default:
0

The starting index of grid lines along the axis

tickangle
Parent:
data[type=carpet].aaxis
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.

tickfont
Parent:
data[type=carpet].aaxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
data[type=carpet].aaxis.tickfont
Type:
color
family
Parent:
data[type=carpet].aaxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=carpet].aaxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=carpet].aaxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=carpet].aaxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=carpet].aaxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=carpet].aaxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=carpet].aaxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=carpet].aaxis.tickformatstops[]
Type:
string

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

value
Parent:
data[type=carpet].aaxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

tickmode
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "linear" | "array" )
Default:
"array"
tickprefix
Parent:
data[type=carpet].aaxis
Type:
string
Default:
""

Sets a tick label prefix.

ticksuffix
Parent:
data[type=carpet].aaxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=carpet].aaxis
Type:
data array

Sets 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=carpet].aaxis
Type:
data array

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

title
Parent:
data[type=carpet].aaxis
Type:
object containing one or more of the keys listed below.
Default:
""

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=carpet].aaxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=carpet].aaxis.title.font
Type:
color
family
Parent:
data[type=carpet].aaxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=carpet].aaxis.title.font
Type:
number greater than or equal to 1
offset
Parent:
data[type=carpet].aaxis.title
Type:
number
Default:
10

An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute.

text
Parent:
data[type=carpet].aaxis.title
Type:
string
Default:
""

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
data[type=carpet].aaxis
Type:
enumerated , one of ( "-" | "linear" | "date" | "category" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

b
Parent:
data[type=carpet]
Type:
data array

A two dimensional array of y coordinates at each carpet point.

b0
Parent:
data[type=carpet]
Type:
number
Default:
0

Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step.

baxis
Parent:
data[type=carpet]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

arraydtick
Parent:
data[type=carpet].baxis
Type:
integer greater than or equal to 1
Default:
1

The stride between grid lines along the axis

arraytick0
Parent:
data[type=carpet].baxis
Type:
integer greater than or equal to 0
Default:
0

The starting index of grid lines along the axis

autorange
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( true | false | "reversed" )
Default:
true

Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "false".

categoryarray
Parent:
data[type=carpet].baxis
Type:
data array

Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.

categoryorder
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" )
Default:
"trace"

Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.

cheatertype
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "index" | "value" )
Default:
"value"
color
Parent:
data[type=carpet].baxis
Type:
color

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

dtick
Parent:
data[type=carpet].baxis
Type:
number greater than or equal to 0
Default:
1

The stride between grid lines along the axis

endline
Parent:
data[type=carpet].baxis
Type:
boolean

Determines whether or not a line is drawn at along the final value of this axis. If "true", the end line is drawn on top of the grid lines.

endlinecolor
Parent:
data[type=carpet].baxis
Type:
color

Sets the line color of the end line.

endlinewidth
Parent:
data[type=carpet].baxis
Type:
number
Default:
1

Sets the width (in px) of the end line.

exponentformat
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

fixedrange
Parent:
data[type=carpet].baxis
Type:
boolean

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

gridcolor
Parent:
data[type=carpet].baxis
Type:
color

Sets the axis line color.

gridwidth
Parent:
data[type=carpet].baxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

labelpadding
Parent:
data[type=carpet].baxis
Type:
integer
Default:
10

Extra padding between label and the axis

labelprefix
Parent:
data[type=carpet].baxis
Type:
string

Sets a axis label prefix.

labelsuffix
Parent:
data[type=carpet].baxis
Type:
string
Default:
""

Sets a axis label suffix.

linecolor
Parent:
data[type=carpet].baxis
Type:
color
Default:
"#444"

Sets the axis line color.

linewidth
Parent:
data[type=carpet].baxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

minorgridcolor
Parent:
data[type=carpet].baxis
Type:
color
Default:
"#eee"

Sets the color of the grid lines.

minorgridcount
Parent:
data[type=carpet].baxis
Type:
integer greater than or equal to 0
Default:
0

Sets the number of minor grid ticks per major grid tick

minorgridwidth
Parent:
data[type=carpet].baxis
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the grid lines.

nticks
Parent:
data[type=carpet].baxis
Type:
integer greater than or equal to 0
Default:
0

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

range
Parent:
data[type=carpet].baxis
Type:
array

Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

rangemode
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "normal" | "tozero" | "nonnegative" )
Default:
"normal"

If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.

separatethousands
Parent:
data[type=carpet].baxis
Type:
boolean

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

showexponent
Parent:
data[type=carpet].baxis
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.

showgrid
Parent:
data[type=carpet].baxis
Type:
boolean
Default:
true

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

showline
Parent:
data[type=carpet].baxis
Type:
boolean

Determines whether or not a line bounding this axis is drawn.

showticklabels
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "start" | "end" | "both" | "none" )
Default:
"start"

Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

showtickprefix
Parent:
data[type=carpet].baxis
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=carpet].baxis
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

smoothing
Parent:
data[type=carpet].baxis
Type:
number between or equal to 0 and 1.3
Default:
1
startline
Parent:
data[type=carpet].baxis
Type:
boolean

Determines whether or not a line is drawn at along the starting value of this axis. If "true", the start line is drawn on top of the grid lines.

startlinecolor
Parent:
data[type=carpet].baxis
Type:
color

Sets the line color of the start line.

startlinewidth
Parent:
data[type=carpet].baxis
Type:
number
Default:
1

Sets the width (in px) of the start line.

tick0
Parent:
data[type=carpet].baxis
Type:
number greater than or equal to 0
Default:
0

The starting index of grid lines along the axis

tickangle
Parent:
data[type=carpet].baxis
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.

tickfont
Parent:
data[type=carpet].baxis
Type:
object containing one or more of the keys listed below.

Sets the tick font.

color
Parent:
data[type=carpet].baxis.tickfont
Type:
color
family
Parent:
data[type=carpet].baxis.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=carpet].baxis.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=carpet].baxis
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=carpet].baxis
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=carpet].baxis.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=carpet].baxis.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=carpet].baxis.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=carpet].baxis.tickformatstops[]
Type:
string

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

value
Parent:
data[type=carpet].baxis.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

tickmode
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "linear" | "array" )
Default:
"array"
tickprefix
Parent:
data[type=carpet].baxis
Type:
string
Default:
""

Sets a tick label prefix.

ticksuffix
Parent:
data[type=carpet].baxis
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=carpet].baxis
Type:
data array

Sets 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=carpet].baxis
Type:
data array

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

title
Parent:
data[type=carpet].baxis
Type:
object containing one or more of the keys listed below.
Default:
""

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=carpet].baxis.title
Type:
object containing one or more of the keys listed below.

Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=carpet].baxis.title.font
Type:
color
family
Parent:
data[type=carpet].baxis.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=carpet].baxis.title.font
Type:
number greater than or equal to 1
offset
Parent:
data[type=carpet].baxis.title
Type:
number
Default:
10

An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute.

text
Parent:
data[type=carpet].baxis.title
Type:
string
Default:
""

Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

type
Parent:
data[type=carpet].baxis
Type:
enumerated , one of ( "-" | "linear" | "date" | "category" )
Default:
"-"

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

carpet
Parent:
data[type=carpet]
Type:
string

An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie

cheaterslope
Parent:
data[type=carpet]
Type:
number
Default:
1

The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been ommitted.

color
Parent:
data[type=carpet]
Type:
color
Default:
"#444"

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

customdata
Parent:
data[type=carpet]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

da
Parent:
data[type=carpet]
Type:
number
Default:
1

Sets the a coordinate step. See `a0` for more info.

db
Parent:
data[type=carpet]
Type:
number
Default:
1

Sets the b coordinate step. See `b0` for more info.

font
Parent:
data[type=carpet]
Type:
object containing one or more of the keys listed below.
Default:
""Open Sans", verdana, arial, sans-serif"

The default font used for axis & tick labels on this carpet

color
Parent:
data[type=carpet].font
Type:
color
Default:
"#444"
family
Parent:
data[type=carpet].font
Type:
string
Default:
""Open Sans", verdana, arial, sans-serif"

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=carpet].font
Type:
number greater than or equal to 1
Default:
12
ids
Parent:
data[type=carpet]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

meta
Parent:
data[type=carpet]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=carpet]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=carpet]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

type
Parent:
data[type=carpet]
Type:
"carpet"
uirevision
Parent:
data[type=carpet]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=carpet]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=carpet]
Type:
data array

A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default.

xaxis
Parent:
data[type=carpet]
Type:
subplotid
Default:
x

Sets 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.

y
Parent:
data[type=carpet]
Type:
data array

A two dimensional array of y coordinates at each carpet point.

yaxis
Parent:
data[type=carpet]
Type:
subplotid
Default:
y

Sets 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.

44. Scattercarpet traces

A scattercarpet trace is an object with the key "type" equal to "scattercarpet" (i.e. {"type": "scattercarpet"}) and any of the keys listed below. Plots a scatter trace on either the first carpet axis or the carpet axis with a matching `carpet` attribute.

a
Parent:
data[type=scattercarpet]
Type:
data array

Sets the a-axis coordinates.

b
Parent:
data[type=scattercarpet]
Type:
data array

Sets the b-axis coordinates.

carpet
Parent:
data[type=scattercarpet]
Type:
string

An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie

connectgaps
Parent:
data[type=scattercarpet]
Type:
boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata
Parent:
data[type=scattercarpet]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

fill
Parent:
data[type=scattercarpet]
Type:
enumerated , one of ( "none" | "toself" | "tonext" )
Default:
"none"

Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "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.

fillcolor
Parent:
data[type=scattercarpet]
Type:
color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo
Parent:
data[type=scattercarpet]
Type:
flaglist string. Any combination of "a", "b", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=scattercarpet]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=scattercarpet].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=scattercarpet].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=scattercarpet].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=scattercarpet].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=scattercarpet].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=scattercarpet].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattercarpet].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=scattercarpet].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

hoveron
Parent:
data[type=scattercarpet]
Type:
flaglist string. Any combination of "points", "fills" joined with a "+"

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".

hovertemplate
Parent:
data[type=scattercarpet]
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every 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>`.

hovertext
Parent:
data[type=scattercarpet]
Type:
string or array of strings
Default:
""

Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a "text" flag.

ids
Parent:
data[type=scattercarpet]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=scattercarpet]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=scattercarpet]
Type:
object containing one or more of the keys listed below.
Default:
2

Sets the line color.

color
Parent:
data[type=scattercarpet].line
Type:
color

Sets the line color.

dash
Parent:
data[type=scattercarpet].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=scattercarpet].line
Type:
enumerated , one of ( "linear" | "spline" )
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.

smoothing
Parent:
data[type=scattercarpet].line
Type:
number between or equal to 0 and 1.3
Default:
1

Has 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=scattercarpet].line
Type:
number greater than or equal to 0
Default:
2

Sets the line width (in px).

marker
Parent:
data[type=scattercarpet]
Type:
object containing one or more of the keys listed below.
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.

autocolorscale
Parent:
data[type=scattercarpet].marker
Type:
boolean
Default:
true

Determines 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=scattercarpet].marker
Type:
boolean
Default:
true

Determines 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=scattercarpet].marker
Type:
number

Sets 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=scattercarpet].marker
Type:
number

Sets 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=scattercarpet].marker
Type:
number

Sets 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=scattercarpet].marker
Type:
color or array of colors

Sets themarkercolor. 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=scattercarpet].marker
Type:
subplotid

Sets 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=scattercarpet].marker
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=scattercarpet].marker.colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=scattercarpet].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=scattercarpet].marker.colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=scattercarpet].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.

nticks
Parent:
data[type=scattercarpet].marker.colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=scattercarpet].marker.colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=scattercarpet].marker.colorbar
Type:
boolean

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

showexponent
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar.tickfont
Type:
color
family
Parent:
data[type=scattercarpet].marker.colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattercarpet].marker.colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=scattercarpet].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=scattercarpet].marker.colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=scattercarpet].marker.colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=scattercarpet].marker.colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=scattercarpet].marker.colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=scattercarpet].marker.colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=scattercarpet].marker.colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=scattercarpet].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=scattercarpet].marker.colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=scattercarpet].marker.colorbar
Type:
data array

Sets 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=scattercarpet].marker.colorbar
Type:
data array

Sets 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=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=scattercarpet].marker.colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=scattercarpet].marker.colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=scattercarpet].marker.colorbar.title.font
Type:
color
family
Parent:
data[type=scattercarpet].marker.colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattercarpet].marker.colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=scattercarpet].marker.colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=scattercarpet].marker.colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=scattercarpet].marker.colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=scattercarpet].marker.colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=scattercarpet].marker.colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=scattercarpet].marker
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

gradient
Parent:
data[type=scattercarpet].marker
Type:
object containing one or more of the keys listed below.
Default:
"none"

Sets the type of gradient used to fill the markers

color
Parent:
data[type=scattercarpet].marker.gradient
Type:
color or array of colors

Sets 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=scattercarpet].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

line
Parent:
data[type=scattercarpet].marker
Type:
object containing one or more of the keys listed below.
Default:
true

Sets the width (in px) of the lines bounding the marker points.

autocolorscale
Parent:
data[type=scattercarpet].marker.line
Type:
boolean
Default:
true

Determines 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=scattercarpet].marker.line
Type:
boolean
Default:
true

Determines 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=scattercarpet].marker.line
Type:
number

Sets 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=scattercarpet].marker.line
Type:
number

Sets 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=scattercarpet].marker.line
Type:
number

Sets 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=scattercarpet].marker.line
Type:
color or array of colors

Sets themarker.linecolor. 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=scattercarpet].marker.line
Type:
subplotid

Sets 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=scattercarpet].marker.line
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

reversescale
Parent:
data[type=scattercarpet].marker.line
Type:
boolean

Reverses 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=scattercarpet].marker.line
Type:
number or array of numbers greater than or equal to 0

Sets the width (in px) of the lines bounding the marker points.

maxdisplayed
Parent:
data[type=scattercarpet].marker
Type:
number greater than or equal to 0
Default:
0

Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

opacity
Parent:
data[type=scattercarpet].marker
Type:
number or array of numbers between or equal to 0 and 1

Sets the marker opacity.

reversescale
Parent:
data[type=scattercarpet].marker
Type:
boolean

Reverses 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=scattercarpet].marker
Type:
boolean

Determines 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=scattercarpet].marker
Type:
number or array of numbers greater than or equal to 0
Default:
6

Sets the marker size (in px).

sizemin
Parent:
data[type=scattercarpet].marker
Type:
number greater than or equal to 0
Default:
0

Has 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=scattercarpet].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=scattercarpet].marker
Type:
number
Default:
1

Has 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=scattercarpet].marker
Type:
enumerated or array of enumerateds , one of ( "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-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.

meta
Parent:
data[type=scattercarpet]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

mode
Parent:
data[type=scattercarpet]
Type:
flaglist string. Any combination of "lines", "markers", "text" joined with a "+" OR "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".

name
Parent:
data[type=scattercarpet]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=scattercarpet]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

selected
Parent:
data[type=scattercarpet]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

marker
Parent:
data[type=scattercarpet].selected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of selected points.

color
Parent:
data[type=scattercarpet].selected.marker
Type:
color

Sets the marker color of selected points.

opacity
Parent:
data[type=scattercarpet].selected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of selected points.

size
Parent:
data[type=scattercarpet].selected.marker
Type:
number greater than or equal to 0

Sets the marker size of selected points.

textfont
Parent:
data[type=scattercarpet].selected
Type:
object containing one or more of the keys listed below.

Sets the text font color of selected points.

color
Parent:
data[type=scattercarpet].selected.textfont
Type:
color

Sets the text font color of selected points.

selectedpoints
Parent:
data[type=scattercarpet]
Type:
number or categorical coordinate string

Array 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.

showlegend
Parent:
data[type=scattercarpet]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

text
Parent:
data[type=scattercarpet]
Type:
string or array of strings
Default:
""

Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

textfont
Parent:
data[type=scattercarpet]
Type:
object containing one or more of the keys listed below.

Sets the text font.

color
Parent:
data[type=scattercarpet].textfont
Type:
color or array of colors
family
Parent:
data[type=scattercarpet].textfont
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=scattercarpet].textfont
Type:
number or array of numbers greater than or equal to 1
textposition
Parent:
data[type=scattercarpet]
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=scattercarpet]
Type:
string or array of strings
Default:
""

Template string used for rendering the information text that appear 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-3.x-api-reference/blob/master/Formatting.md#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-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `a`, `b` and `text`.

type
Parent:
data[type=scattercarpet]
Type:
"scattercarpet"
uirevision
Parent:
data[type=scattercarpet]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

unselected
Parent:
data[type=scattercarpet]
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

marker
Parent:
data[type=scattercarpet].unselected
Type:
object containing one or more of the keys listed below.

Sets the marker opacity of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattercarpet].unselected.marker
Type:
color

Sets the marker color of unselected points, applied only when a selection exists.

opacity
Parent:
data[type=scattercarpet].unselected.marker
Type:
number between or equal to 0 and 1

Sets the marker opacity of unselected points, applied only when a selection exists.

size
Parent:
data[type=scattercarpet].unselected.marker
Type:
number greater than or equal to 0

Sets the marker size of unselected points, applied only when a selection exists.

textfont
Parent:
data[type=scattercarpet].unselected
Type:
object containing one or more of the keys listed below.

Sets the text font color of unselected points, applied only when a selection exists.

color
Parent:
data[type=scattercarpet].unselected.textfont
Type:
color

Sets the text font color of unselected points, applied only when a selection exists.

visible
Parent:
data[type=scattercarpet]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

xaxis
Parent:
data[type=scattercarpet]
Type:
subplotid
Default:
x

Sets 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=scattercarpet]
Type:
subplotid
Default:
y

Sets 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.

45. Contourcarpet traces

A contourcarpet trace is an object with the key "type" equal to "contourcarpet" (i.e. {"type": "contourcarpet"}) and any of the keys listed below. Plots contours on either the first carpet axis or the carpet axis with a matching `carpet` attribute. Data `z` is interpreted as matching that of the corresponding carpet axis.

a
Parent:
data[type=contourcarpet]
Type:
data array

Sets the x coordinates.

a0
Parent:
data[type=contourcarpet]
Type:
number or categorical coordinate string
Default:
0

Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

atype
Parent:
data[type=contourcarpet]
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).

autocolorscale
Parent:
data[type=contourcarpet]
Type:
boolean

Determines 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.

autocontour
Parent:
data[type=contourcarpet]
Type:
boolean
Default:
true

Determines 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`.

b
Parent:
data[type=contourcarpet]
Type:
data array

Sets the y coordinates.

b0
Parent:
data[type=contourcarpet]
Type:
number or categorical coordinate string
Default:
0

Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

btype
Parent:
data[type=contourcarpet]
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)

carpet
Parent:
data[type=contourcarpet]
Type:
string

The `carpet` of the carpet axes on which this contour trace lies

coloraxis
Parent:
data[type=contourcarpet]
Type:
subplotid

Sets 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=contourcarpet]
Type:
object containing one or more of the keys listed below.
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.

bgcolor
Parent:
data[type=contourcarpet].colorbar
Type:
color
Default:
"rgba(0,0,0,0)"

Sets the color of padded area.

bordercolor
Parent:
data[type=contourcarpet].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

borderwidth
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
0

Sets the width (in px) or the border enclosing this color bar.

dtick
Parent:
data[type=contourcarpet].colorbar
Type:
number or categorical coordinate string

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

exponentformat
Parent:
data[type=contourcarpet].colorbar
Type:
enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
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.

len
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets 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=contourcarpet].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.

nticks
Parent:
data[type=contourcarpet].colorbar
Type:
integer greater than or equal to 0
Default:
0

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

outlinecolor
Parent:
data[type=contourcarpet].colorbar
Type:
color
Default:
"#444"

Sets the axis line color.

outlinewidth
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the width (in px) of the axis line.

separatethousands
Parent:
data[type=contourcarpet].colorbar
Type:
boolean

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

showexponent
Parent:
data[type=contourcarpet].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=contourcarpet].colorbar
Type:
boolean
Default:
true

Determines whether or not the tick labels are drawn.

showtickprefix
Parent:
data[type=contourcarpet].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=contourcarpet].colorbar
Type:
enumerated , one of ( "all" | "first" | "last" | "none" )
Default:
"all"

Same as `showtickprefix` but for tick suffixes.

thickness
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
30

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Parent:
data[type=contourcarpet].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=contourcarpet].colorbar
Type:
number or categorical coordinate string

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

tickangle
Parent:
data[type=contourcarpet].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=contourcarpet].colorbar
Type:
color
Default:
"#444"

Sets the tick color.

tickfont
Parent:
data[type=contourcarpet].colorbar
Type:
object containing one or more of the keys listed below.

Sets the color bar's tick label font

color
Parent:
data[type=contourcarpet].colorbar.tickfont
Type:
color
family
Parent:
data[type=contourcarpet].colorbar.tickfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contourcarpet].colorbar.tickfont
Type:
number greater than or equal to 1
tickformat
Parent:
data[type=contourcarpet].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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%\M~%S.%2f" would display "09~15~23.46"

tickformatstops
Parent:
data[type=contourcarpet].colorbar
Type:
array of object where each object has one or more of the keys listed below.
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

dtickrange
Parent:
data[type=contourcarpet].colorbar.tickformatstops[]
Type:
array

range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

enabled
Parent:
data[type=contourcarpet].colorbar.tickformatstops[]
Type:
boolean
Default:
true

Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

name
Parent:
data[type=contourcarpet].colorbar.tickformatstops[]
Type:
string

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

templateitemname
Parent:
data[type=contourcarpet].colorbar.tickformatstops[]
Type:
string

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

value
Parent:
data[type=contourcarpet].colorbar.tickformatstops[]
Type:
string
Default:
""

string - dtickformat for described zoom level, the same as "tickformat"

ticklen
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
5

Sets the tick length (in px).

tickmode
Parent:
data[type=contourcarpet].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=contourcarpet].colorbar
Type:
string
Default:
""

Sets a tick label prefix.

ticks
Parent:
data[type=contourcarpet].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=contourcarpet].colorbar
Type:
string
Default:
""

Sets a tick label suffix.

ticktext
Parent:
data[type=contourcarpet].colorbar
Type:
data array

Sets 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=contourcarpet].colorbar
Type:
data array

Sets 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=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
1

Sets the tick width (in px).

title
Parent:
data[type=contourcarpet].colorbar
Type:
object containing one or more of the keys listed below.
Default:
"top"

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

font
Parent:
data[type=contourcarpet].colorbar.title
Type:
object containing one or more of the keys listed below.

Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

color
Parent:
data[type=contourcarpet].colorbar.title.font
Type:
color
family
Parent:
data[type=contourcarpet].colorbar.title.font
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contourcarpet].colorbar.title.font
Type:
number greater than or equal to 1
side
Parent:
data[type=contourcarpet].colorbar.title
Type:
enumerated , one of ( "right" | "top" | "bottom" )
Default:
"top"

Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

text
Parent:
data[type=contourcarpet].colorbar.title
Type:
string

Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

x
Parent:
data[type=contourcarpet].colorbar
Type:
number between or equal to -2 and 3
Default:
1.02

Sets the x position of the color bar (in plot fraction).

xanchor
Parent:
data[type=contourcarpet].colorbar
Type:
enumerated , one of ( "left" | "center" | "right" )
Default:
"left"

Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

xpad
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the x direction.

y
Parent:
data[type=contourcarpet].colorbar
Type:
number between or equal to -2 and 3
Default:
0.5

Sets the y position of the color bar (in plot fraction).

yanchor
Parent:
data[type=contourcarpet].colorbar
Type:
enumerated , one of ( "top" | "middle" | "bottom" )
Default:
"middle"

Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

ypad
Parent:
data[type=contourcarpet].colorbar
Type:
number greater than or equal to 0
Default:
10

Sets the amount of padding (in px) along the y direction.

colorscale
Parent:
data[type=contourcarpet]
Type:
colorscale

Sets 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: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

contours
Parent:
data[type=contourcarpet]
Type:
object containing one or more of the keys listed below.
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.

coloring
Parent:
data[type=contourcarpet].contours
Type:
enumerated , one of ( "fill" | "lines" | "none" )
Default:
"fill"

Determines the coloring method showing the contour values. If "fill", coloring is done evenly 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=contourcarpet].contours
Type:
number

Sets the end contour level value. Must be more than `contours.start`

labelfont
Parent:
data[type=contourcarpet].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=contourcarpet].contours.labelfont
Type:
color
family
Parent:
data[type=contourcarpet].contours.labelfont
Type:
string

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=contourcarpet].contours.labelfont
Type:
number greater than or equal to 1
labelformat
Parent:
data[type=contourcarpet].contours
Type:
string
Default:
""

Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

operation
Parent:
data[type=contourcarpet].contours
Type:
enumerated , one of ( "=" | "&lt;" | "&gt;=" | "&gt;" | "&lt;=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
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=contourcarpet].contours
Type:
boolean

Determines whether to label the contour lines with their values.

showlines
Parent:
data[type=contourcarpet].contours
Type:
boolean
Default:
true

Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".

size
Parent:
data[type=contourcarpet].contours
Type:
number greater than or equal to 0

Sets the step between each contour level. Must be positive.

start
Parent:
data[type=contourcarpet].contours
Type:
number

Sets the starting contour level value. Must be less than `contours.end`

type
Parent:
data[type=contourcarpet].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=contourcarpet].contours
Type:
number or categorical coordinate string
Default:
0

Sets 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.

customdata
Parent:
data[type=contourcarpet]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

da
Parent:
data[type=contourcarpet]
Type:
number
Default:
1

Sets the x coordinate step. See `x0` for more info.

db
Parent:
data[type=contourcarpet]
Type:
number
Default:
1

Sets the y coordinate step. See `y0` for more info.

fillcolor
Parent:
data[type=contourcarpet]
Type:
color

Sets 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.

hovertext
Parent:
data[type=contourcarpet]
Type:
data array

Same as `text`.

ids
Parent:
data[type=contourcarpet]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

legendgroup
Parent:
data[type=contourcarpet]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

line
Parent:
data[type=contourcarpet]
Type:
object containing one or more of the keys listed below.
Default:
"solid"

Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".

color
Parent:
data[type=contourcarpet].line
Type:
color

Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".

dash
Parent:
data[type=contourcarpet].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=contourcarpet].line
Type:
number between or equal to 0 and 1.3
Default:
1

Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.

width
Parent:
data[type=contourcarpet].line
Type:
number greater than or equal to 0

Sets the contour line width in (in px) Defaults to "0.5" when `contours.type` is "levels". Defaults to "2" when `contour.type` is "constraint".

meta
Parent:
data[type=contourcarpet]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=contourcarpet]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

ncontours
Parent:
data[type=contourcarpet]
Type:
integer greater than or equal to 1
Default:
15

Sets 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.

opacity
Parent:
data[type=contourcarpet]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

reversescale
Parent:
data[type=contourcarpet]
Type:
boolean

Reverses 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.

showlegend
Parent:
data[type=contourcarpet]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale
Parent:
data[type=contourcarpet]
Type:
boolean
Default:
true

Determines whether or not a colorbar is displayed for this trace.

text
Parent:
data[type=contourcarpet]
Type:
data array

Sets the text elements associated with each z value.

transpose
Parent:
data[type=contourcarpet]
Type:
boolean

Transposes the z data.

type
Parent:
data[type=contourcarpet]
Type:
"contourcarpet"
uirevision
Parent:
data[type=contourcarpet]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=contourcarpet]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

xaxis
Parent:
data[type=contourcarpet]
Type:
subplotid
Default:
x

Sets 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=contourcarpet]
Type:
subplotid
Default:
y

Sets 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.

z
Parent:
data[type=contourcarpet]
Type:
data array

Sets the z data.

zauto
Parent:
data[type=contourcarpet]
Type:
boolean
Default:
true

Determines 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.

zmax
Parent:
data[type=contourcarpet]
Type:
number

Sets 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=contourcarpet]
Type:
number

Sets 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=contourcarpet]
Type:
number

Sets 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.

46. Pointcloud traces

A pointcloud trace is an object with the key "type" equal to "pointcloud" (i.e. {"type": "pointcloud"}) and any of the keys listed below. The data visualized as a point cloud set in `x` and `y` using the WebGl plotting engine.

customdata
Parent:
data[type=pointcloud]
Type:
data array

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

hoverinfo
Parent:
data[type=pointcloud]
Type:
flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
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.

hoverlabel
Parent:
data[type=pointcloud]
Type:
object containing one or more of the keys listed below.
Default:
"auto"

Sets the background color of the hover labels for this trace

align
Parent:
data[type=pointcloud].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=pointcloud].hoverlabel
Type:
color or array of colors

Sets the background color of the hover labels for this trace

bordercolor
Parent:
data[type=pointcloud].hoverlabel
Type:
color or array of colors

Sets the border color of the hover labels for this trace.

font
Parent:
data[type=pointcloud].hoverlabel
Type:
object containing one or more of the keys listed below.

Sets the font used in hover labels.

color
Parent:
data[type=pointcloud].hoverlabel.font
Type:
color or array of colors
family
Parent:
data[type=pointcloud].hoverlabel.font
Type:
string or array of strings

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

size
Parent:
data[type=pointcloud].hoverlabel.font
Type:
number or array of numbers greater than or equal to 1
namelength
Parent:
data[type=pointcloud].hoverlabel
Type:
integer or array of integers greater than or equal to -1
Default:
15

Sets 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.

ids
Parent:
data[type=pointcloud]
Type:
data array

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

indices
Parent:
data[type=pointcloud]
Type:
data array

A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.

legendgroup
Parent:
data[type=pointcloud]
Type:
string
Default:
""

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

marker
Parent:
data[type=pointcloud]
Type:
object containing one or more of the keys listed below.
Default:
1

Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are hundreds of thousandsof points, it may cause slower zooming and panning.

blend
Parent:
data[type=pointcloud].marker
Type:
boolean

Determines if colors are blended together for a translucency effect in case `opacity` is specified as a value less then `1`. Setting `blend` to `true` reduces zoom/pan speed if used with large numbers of points.

border
Parent:
data[type=pointcloud].marker
Type:
object containing one or more of the keys listed below.
Default:
0

Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.

arearatio
Parent:
data[type=pointcloud].marker.border
Type:
number between or equal to 0 and 1
Default:
0

Specifies what fraction of the marker area is covered with the border.

color
Parent:
data[type=pointcloud].marker.border
Type:
color

Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.

color
Parent:
data[type=pointcloud].marker
Type:
color

Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are hundreds of thousandsof points, it may cause slower zooming and panning.

opacity
Parent:
data[type=pointcloud].marker
Type:
number between or equal to 0 and 1
Default:
1

Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `false` even if there is no translucency effect in that case.

sizemax
Parent:
data[type=pointcloud].marker
Type:
number greater than or equal to 0.1
Default:
20

Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points.

sizemin
Parent:
data[type=pointcloud].marker
Type:
number between or equal to 0.1 and 2
Default:
0.5

Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points.

meta
Parent:
data[type=pointcloud]
Type:
number or categorical coordinate string

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

name
Parent:
data[type=pointcloud]
Type:
string

Sets the trace name. The trace name appear as the legend item and on hover.

opacity
Parent:
data[type=pointcloud]
Type:
number between or equal to 0 and 1
Default:
1

Sets the opacity of the trace.

showlegend
Parent:
data[type=pointcloud]
Type:
boolean
Default:
true

Determines whether or not an item corresponding to this trace is shown in the legend.

text
Parent:
data[type=pointcloud]
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.

type
Parent:
data[type=pointcloud]
Type:
"pointcloud"
uirevision
Parent:
data[type=pointcloud]
Type:
number or categorical coordinate string

Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

visible
Parent:
data[type=pointcloud]
Type:
enumerated , one of ( true | false | "legendonly" )
Default:
true

Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x
Parent:
data[type=pointcloud]
Type:
data array

Sets the x coordinates.

xaxis
Parent:
data[type=pointcloud]
Type:
subplotid
Default:
x

Sets 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.

xbounds
Parent:
data[type=pointcloud]
Type:
data array

Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.

xy
Parent:
data[type=pointcloud]
Type:
data array

Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i " 2] = x[i]` and `xy[i " 2 + 1] = y[i]`

y
Parent:
data[type=pointcloud]
Type:
data array

Sets the y coordinates.

yaxis
Parent:
data[type=pointcloud]
Type:
subplotid
Default:
y

Sets 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.

ybounds
Parent:
data[type=pointcloud]
Type:
data array

Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.