plotly.graph_objects.Choropleth¶

class plotly.graph_objects.Choropleth(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertext=None, ids=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, marker=None, meta=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, text=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, **kwargs)¶

__init__(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertext=None, ids=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, locationmode=None, locations=None, marker=None, meta=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, text=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, **kwargs)¶

Construct a new Choropleth object

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.

Parameters

• arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Choropleth

• autocolorscale – 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 – 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 – plotly.graph_objects.choropleth.ColorBar instance or dict with compatible properties

• colorscale – Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Bl ues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic, Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

• customdata – 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

• featureidkey – Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example “properties.name”.

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

• geojson – Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type “FeatureCollection” or “Feature” with geometries of type “Polygon” or “MultiPolygon”.

• hoverinfo – Determines what trace information appears 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 – plotly.graph_objects.choropleth.Hoverlabel instance or dict with compatible properties

• hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, all attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example <extra>%{fullData.name}</extra>. To hide the secondary box completely, use an empty tag <extra></extra>.

• hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.

• hovertext – Same as text.

• ids – 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.

• legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

• legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

• legendgrouptitle – plotly.graph_objects.choropleth.Legendgrouptitl e instance or dict with compatible properties

• legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

• legendwidth – Sets the width (in px or fraction) of the legend for this trace.

• locationmode – Determines the set of locations used to match entries in locations to regions on the map. Values “ISO-3”, “USA-states”, country names correspond to features on the base map and value “geojson-id” corresponds to features from a custom GeoJSON linked to the geojson attribute. “USA-states” accepts both two-letter abbreviations (e.g. “CA”) and full state names (e.g. “California”).

• locations – Sets the coordinates via location IDs or names. See locationmode for more info.

• marker – plotly.graph_objects.choropleth.Marker instance or dict with compatible properties

• meta – 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 – Sets the trace name. The trace name appears as the legend item and on hover.

• reversescale – 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 – plotly.graph_objects.choropleth.Selected instance or dict with compatible properties

• selectedpoints – 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 – Determines whether or not an item corresponding to this trace is shown in the legend.

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

• text – Sets the text elements associated with each location.

• uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

• uirevision – 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 – plotly.graph_objects.choropleth.Unselected instance or dict with compatible properties

• visible – 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 – Sets the color values.

• zauto – 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 – 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 – 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 – 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.

Returns

Return type

Choropleth

plotly.graph_objects.choropleth¶

class plotly.graph_objects.choropleth.ColorBar(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, dtick=None, exponentformat=None, labelalias=None, len=None, lenmode=None, minexponent=None, nticks=None, orientation=None, outlinecolor=None, outlinewidth=None, separatethousands=None, showexponent=None, showticklabels=None, showtickprefix=None, showticksuffix=None, thickness=None, thicknessmode=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklabeloverflow=None, ticklabelposition=None, ticklabelstep=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, tickvals=None, tickwidth=None, title=None, x=None, xanchor=None, xpad=None, xref=None, y=None, yanchor=None, ypad=None, yref=None, **kwargs)¶

property bgcolor¶

Sets the color of padded area.

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property bordercolor¶

Sets the axis line color.

The ‘bordercolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property borderwidth¶

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]

Returns

Return type

int|float

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

Any

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. “SI” uses prefixes from “femto” f (10^-15) to “tera” T (10^12). SI extended covers instead the full SI range from “quecto” q (10^-30) to “quetta” Q (10^30). If “SI” or SI extended is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.

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

• One of the following enumeration values:

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

Returns

Return type

Any

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

Any

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]

Returns

Return type

int|float

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’]

Returns

Return type

Any

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]

Returns

Return type

int|float

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 an integer and may be specified as:

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

Returns

Return type

int

property orientation¶

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’]

Returns

Return type

Any

property outlinecolor¶

Sets the axis line color.

The ‘outlinecolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property outlinewidth¶

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]

Returns

Return type

int|float

property separatethousands¶

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

The ‘separatethousands’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

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’]

Returns

Return type

Any

property showticklabels¶

Determines whether or not the tick labels are drawn.

The ‘showticklabels’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

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’]

Returns

Return type

Any

property showticksuffix¶

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’]

Returns

Return type

Any

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]

Returns

Return type

int|float

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’]

Returns

Return type

Any

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

Any

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

property tickcolor¶

Sets the tick color.

The ‘tickcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

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

Returns

Return type

plotly.graph_objects.choropleth.colorbar.Tickfont

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

Returns

Return type

str

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

Returns

Return type

plotly.graph_objects.choropleth.colorbar.Tickformatstop

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

Returns

Return type

tuple[plotly.graph_objects.choropleth.colorbar.Tickformatstop]

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’]

Returns

Return type

Any

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’]

Returns

Return type

Any

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 an integer and may be specified as:

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

Returns

Return type

int

property ticklen¶

Sets the tick length (in px).

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

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

Returns

Return type

int|float

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’]

Returns

Return type

Any

property tickprefix¶

Sets a tick label prefix.

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

• A string

• A number that will be converted to a string

Returns

Return type

str

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’, ‘’]

Returns

Return type

Any

property ticksuffix¶

Sets a tick label suffix.

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

• A string

• A number that will be converted to a string

Returns

Return type

str

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 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 tickwidth¶

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]

Returns

Return type

int|float

property title¶

The ‘title’ property is an instance of Title that may be specified as:

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

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

Returns

Return type

plotly.graph_objects.choropleth.colorbar.Title

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

Returns

Return type

int|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’]

Returns

Return type

Any

property xpad¶

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]

Returns

Return type

int|float

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’]

Returns

Return type

Any

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

Returns

Return type

int|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’]

Returns

Return type

Any

property ypad¶

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]

Returns

Return type

int|float

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’]

Returns

Return type

Any

class plotly.graph_objects.choropleth.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=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

Returns

Return type

Any|numpy.ndarray

property bgcolor¶

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

• A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolor¶

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

The ‘bordercolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

• A list or array of any of the above

Returns

Return type

str|numpy.ndarray

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

Returns

Return type

plotly.graph_objects.choropleth.hoverlabel.Font

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 an 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

Returns

Return type

int|numpy.ndarray

property showarrow¶

Sets whether or not to show the hover label arrow/triangle pointing to the data point.

The ‘showarrow’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

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

Returns

Return type

plotly.graph_objects.choropleth.legendgrouptitle.Font

property text¶

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

Returns

Return type

str

class plotly.graph_objects.choropleth.Marker(arg=None, line=None, opacity=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

Returns

Return type

plotly.graph_objects.choropleth.marker.Line

property opacity¶

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

Returns

Return type

int|float|numpy.ndarray

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

Returns

Return type

plotly.graph_objects.choropleth.selected.Marker

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

Returns

Return type

plotly.graph_objects.choropleth.unselected.Marker