Sets the color of padded area.

• A hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

The ‘bordercolor’ property is a color and may be specified as:

• A hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

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

The ‘borderwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

property dtick ¶

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

The ‘dtick’ property accepts values of any type

Returns
Return type
property exponentformat ¶

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

The ‘exponentformat’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]

property labelalias ¶

Replacement text for specific tick or hover labels. For example using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html- like tags or MathJax.

The ‘labelalias’ property accepts values of any type

Returns
Return type
property len ¶

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.

The ‘len’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

property lenmode ¶

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.

The ‘lenmode’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘fraction’, ‘pixels’]

property minexponent ¶

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is “SI” or “B”.

The ‘minexponent’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

property nticks ¶

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

The ‘nticks’ property is a integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Sets the orientation of the colorbar.

The ‘orientation’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘h’, ‘v’]

The ‘outlinecolor’ property is a color and may be specified as:

• A hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

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

The ‘outlinewidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

property separatethousands ¶

If “true”, even 4-digit integers are separated

The ‘separatethousands’ property must be specified as a bool (either True, or False)

Returns
Return type
property showexponent ¶

If “all”, all exponents are shown besides their significands. If “first”, only the exponent of the first tick is shown. If “last”, only the exponent of the last tick is shown. If “none”, no exponents appear.

The ‘showexponent’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘all’, ‘first’, ‘last’, ‘none’]

property showticklabels ¶

Determines whether or not the tick labels are drawn.

The ‘showticklabels’ property must be specified as a bool (either True, or False)

Returns
Return type
property showtickprefix ¶

If “all”, all tick labels are displayed with a prefix. If “first”, only the first tick is displayed with a prefix. If “last”, only the last tick is displayed with a suffix. If “none”, tick prefixes are hidden.

The ‘showtickprefix’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘all’, ‘first’, ‘last’, ‘none’]

Same as showtickprefix but for tick suffixes.

The ‘showticksuffix’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘all’, ‘first’, ‘last’, ‘none’]

property thickness ¶

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

The ‘thickness’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

property thicknessmode ¶

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.

The ‘thicknessmode’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘fraction’, ‘pixels’]

property tick0 ¶

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

The ‘tick0’ property accepts values of any type

Returns
Return type
property tickangle ¶

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

The ‘tickangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).

Returns
Return type

int|float

The ‘tickcolor’ property is a color and may be specified as:

• A hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

A named CSS color:

aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

property tickfont ¶

Sets the color bar’s tick label font

The ‘tickfont’ property is an instance of Tickfont that may be specified as:

An instance of plotly.graph_objects.choropleth.colorbar.Tickfont

A dict of string/value properties that will be passed to the Tickfont constructor

Supported dict properties:

color

family

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 Chart Studio Cloud (at https://chart-studio.plotly.com 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”.

lineposition

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

shadow

Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en - US/docs/Web/CSS/text-shadow for additional options.

style

Sets whether a font should be styled with a normal or italic face from its family.

textcase

Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.

variant

Sets the variant of the font.

weight

Sets the weight (or boldness) of the font.

property tickformat ¶

Sets the tick label formatting rule using d3 formatting mini- languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format . And for dates see: https://github.com/d3/d3-time - format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

The ‘tickformat’ property is a string and must be specified as:

• A string

• A number that will be converted to a string

property tickformatstopdefaults ¶

When used in a template (as layout.template.data.choropleth.col orbar.tickformatstopdefaults), sets the default property values to use for elements of choropleth.colorbar.tickformatstops

The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:

An instance of plotly.graph_objects.choropleth.colorbar.Tickformatstop

A dict of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

property tickformatstops ¶

The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:

A list or tuple of instances of plotly.graph_objects.choropleth.colorbar.Tickformatstop

A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor

Supported dict properties:

dtickrange

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

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

name

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

templateitemname

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

value

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

property ticklabeloverflow ¶

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain . In other cases the default is hide past div .

The ‘ticklabeloverflow’ property is an enumeration that may be specified as:

One of the following enumeration values:

[‘allow’, ‘hide past div’, ‘hide past domain’]

property ticklabelposition ¶

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is “h”, top and bottom when orientation is “v”.

The ‘ticklabelposition’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘outside’, ‘inside’, ‘outside top’, ‘inside top’, ‘outside left’, ‘inside left’, ‘outside right’, ‘inside right’, ‘outside bottom’, ‘inside bottom’]

property ticklabelstep ¶

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type “log” or “multicategory”, or when tickmode is “array”.

The ‘ticklabelstep’ property is a integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]

property tickmode ¶

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

The ‘tickmode’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘auto’, ‘linear’, ‘array’]

property ticks ¶

Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.

The ‘ticks’ property is an enumeration that may be specified as:
One of the following enumeration values:

[‘outside’, ‘inside’, ‘’]

property ticktext ¶

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

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type

numpy.ndarray

property ticktextsrc ¶

Sets the source reference on Chart Studio Cloud for ticktext .

The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type
property tickvals ¶

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

The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type

numpy.ndarray

property tickvalssrc ¶

Sets the source reference on Chart Studio Cloud for tickvals .

The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type

Sets the tick width (in px).

The ‘tickwidth’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

• An instance of plotly.graph_objects.choropleth.colorbar.Title

• A dict of string/value properties that will be passed to the Title constructor

  Supported dict properties:

  font

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

  side

  Determines the location of color bar’s title with respect to the color bar. Defaults to “top” when orientation if “v” and defaults to “right” when orientation if “h”. Note that the title’s location used to be set by the now deprecated titleside attribute.

  text

  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.

  property titlefont ¶

  Please use choropleth.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

  The ‘font’ property is an instance of Font that may be specified as:

  An instance of plotly.graph_objects.choropleth.colorbar.title.Font

  A dict of string/value properties that will be passed to the Font constructor

  Supported dict properties:

  color

  family

  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 Chart Studio Cloud (at https://chart-studio.plotly.com 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”.

  lineposition

  Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

  shadow

  Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en - US/docs/Web/CSS/text-shadow for additional options.

  style

  Sets whether a font should be styled with a normal or italic face from its family.

  textcase

  Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.

  variant

  Sets the variant of the font.

  weight

  Sets the weight (or boldness) of the font.

  property titleside ¶

  Please use choropleth.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Defaults to “top” when orientation if “v” and defaults to “right” when orientation if “h”. Note that the title’s location used to be set by the now deprecated titleside attribute.

  The ‘side’ property is an enumeration that may be specified as:

  One of the following enumeration values:

  [‘right’, ‘top’, ‘bottom’]

  property x ¶

  Sets the x position with respect to xref of the color bar (in plot fraction). When xref is “paper”, defaults to 1.02 when orientation is “v” and 0.5 when orientation is “h”. When xref is “container”, defaults to 1 when orientation is “v” and 0.5 when orientation is “h”. Must be between 0 and 1 if xref is “container” and between “-2” and 3 if xref is “paper”.

  The ‘x’ property is a number and may be specified as:

  • An int or float

  property xanchor ¶

  Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar. Defaults to “left” when orientation is “v” and “center” when orientation is “h”.

  The ‘xanchor’ property is an enumeration that may be specified as:
  One of the following enumeration values:

  [‘left’, ‘center’, ‘right’]

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

  The ‘xpad’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

  property xref ¶

  Sets the container x refers to. “container” spans the entire width of the plot. “paper” refers to the width of the plotting area only.

  The ‘xref’ property is an enumeration that may be specified as:
  One of the following enumeration values:

  [‘container’, ‘paper’]

  property y ¶

  Sets the y position with respect to yref of the color bar (in plot fraction). When yref is “paper”, defaults to 0.5 when orientation is “v” and 1.02 when orientation is “h”. When yref is “container”, defaults to 0.5 when orientation is “v” and 1 when orientation is “h”. Must be between 0 and 1 if yref is “container” and between “-2” and 3 if yref is “paper”.

  The ‘y’ property is a number and may be specified as:

  • An int or float

  property yanchor ¶

  Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” when orientation is “v” and “bottom” when orientation is “h”.

  The ‘yanchor’ property is an enumeration that may be specified as:
  One of the following enumeration values:

  [‘top’, ‘middle’, ‘bottom’]

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

  The ‘ypad’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

  property yref ¶

  Sets the container y refers to. “container” spans the entire height of the plot. “paper” refers to the height of the plotting area only.

  The ‘yref’ property is an enumeration that may be specified as:
  One of the following enumeration values:

  [‘container’, ‘paper’]

  class plotly.graph_objects.choropleth. Hoverlabel ( arg = None , align = None , alignsrc = None , bgcolor = None , bgcolorsrc = None , bordercolor = None , bordercolorsrc = None , font = None , namelength = None , namelengthsrc = None , ** kwargs ) ¶ property align ¶

  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

  The ‘align’ property is an enumeration that may be specified as:
  One of the following enumeration values:

  [‘left’, ‘right’, ‘auto’]

  A tuple, list, or one-dimensional numpy array of the above

  property alignsrc ¶

  Sets the source reference on Chart Studio Cloud for align .

  The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

  Returns
  Return type

  Sets the background color of the hover labels for this trace

  The ‘bgcolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  A named CSS color:

  aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  A list or array of any of the above

  property bgcolorsrc ¶

  Sets the source reference on Chart Studio Cloud for bgcolor .

  The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

  Returns
  Return type

  Sets the border color of the hover labels for this trace.

  The ‘bordercolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  A named CSS color:

  aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  A list or array of any of the above

  property bordercolorsrc ¶

  Sets the source reference on Chart Studio Cloud for bordercolor .

  The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

  Returns
  Return type
  property font ¶

  Sets the font used in hover labels.

  The ‘font’ property is an instance of Font that may be specified as:

  An instance of plotly.graph_objects.choropleth.hoverlabel.Font

  A dict of string/value properties that will be passed to the Font constructor

  Supported dict properties:

  color

  colorsrc

  Sets the source reference on Chart Studio Cloud for color .

  family

  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 Chart Studio Cloud (at https://chart-studio.plotly.com 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”.

  familysrc

  Sets the source reference on Chart Studio Cloud for family .

  lineposition

  Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

  linepositionsrc

  Sets the source reference on Chart Studio Cloud for lineposition .

  shadow

  Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en - US/docs/Web/CSS/text-shadow for additional options.

  shadowsrc

  Sets the source reference on Chart Studio Cloud for shadow .

  sizesrc

  Sets the source reference on Chart Studio Cloud for size .

  style

  Sets whether a font should be styled with a normal or italic face from its family.

  stylesrc

  Sets the source reference on Chart Studio Cloud for style .

  textcase

  Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.

  textcasesrc

  Sets the source reference on Chart Studio Cloud for textcase .

  variant

  Sets the variant of the font.

  variantsrc

  Sets the source reference on Chart Studio Cloud for variant .

  weight

  Sets the weight (or boldness) of the font.

  weightsrc

  Sets the source reference on Chart Studio Cloud for weight .

  property namelength ¶

  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.

  The ‘namelength’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]

  • A tuple, list, or one-dimensional numpy array of the above

  Sets the source reference on Chart Studio Cloud for namelength .

  The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

  Returns
  Return type
  class plotly.graph_objects.choropleth. Legendgrouptitle ( arg = None , font = None , text = None , ** kwargs ) ¶ property font ¶

  Sets this legend group’s title font.

  The ‘font’ property is an instance of Font that may be specified as:

  An instance of plotly.graph_objects.choropleth.legendgrouptitle.Font

  A dict of string/value properties that will be passed to the Font constructor

  Supported dict properties:

  color

  family

  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 Chart Studio Cloud (at https://chart-studio.plotly.com 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”.

  lineposition

  Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

  shadow

  Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en - US/docs/Web/CSS/text-shadow for additional options.

  style

  Sets whether a font should be styled with a normal or italic face from its family.

  textcase

  Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.

  variant

  Sets the variant of the font.

  weight

  Sets the weight (or boldness) of the font.

  Sets the title of the legend group.

  The ‘text’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

  class plotly.graph_objects.choropleth. Marker ( arg = None , line = None , opacity = None , opacitysrc = None , ** kwargs ) ¶ property line ¶

  The ‘line’ property is an instance of Line that may be specified as:

  An instance of plotly.graph_objects.choropleth.marker.Line

  A dict of string/value properties that will be passed to the Line constructor

  Supported dict properties:

  color

  Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if

  colorsrc

  Sets the source reference on Chart Studio Cloud for color .

  width

  Sets the width (in px) of the lines bounding the marker points.

  widthsrc

  Sets the source reference on Chart Studio Cloud for width .

  Sets the opacity of the locations.

  The ‘opacity’ property is a number and may be specified as:

  • An int or float in the interval [0, 1]

  • A tuple, list, or one-dimensional numpy array of the above

  property opacitysrc ¶

  Sets the source reference on Chart Studio Cloud for opacity .

  The ‘opacitysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

  Returns
  Return type
  class plotly.graph_objects.choropleth. Selected ( arg = None , marker = None , ** kwargs ) ¶ property marker ¶

  The ‘marker’ property is an instance of Marker that may be specified as:

  An instance of plotly.graph_objects.choropleth.selected.Marker

  A dict of string/value properties that will be passed to the Marker constructor

  Supported dict properties:

  opacity

  Sets the marker opacity of selected points.

  class plotly.graph_objects.choropleth. Stream ( arg = None , maxpoints = None , token = None , ** kwargs ) ¶ property maxpoints ¶

  Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

  The ‘maxpoints’ property is a number and may be specified as:

  • An int or float in the interval [0, 10000]

  property token ¶

  The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

  The ‘token’ property is a string and must be specified as:

  • A non-empty string

  class plotly.graph_objects.choropleth. Unselected ( arg = None , marker = None , ** kwargs ) ¶ property marker ¶

  The ‘marker’ property is an instance of Marker that may be specified as:

  An instance of plotly.graph_objects.choropleth.unselected.Marker

  A dict of string/value properties that will be passed to the Marker constructor

  Supported dict properties:

  opacity

  Sets the marker opacity of unselected points, applied only when a selection exists.