API Reference
< Back to docs
Switch to new Anvil Editor docs Switch to Classic Editor docs
You are currently viewing the new Anvil Editor Docs.
Switch to the Classic Editor Docs
You are currently viewing the Classic Editor Docs.
Switch to the new Anvil Editor Docs

plotly.graph_objs.choropleth Module

Globals

Functions

plotly.graph_objs.choropleth.ColorBar([_deprecated=], [bgcolor=], [bordercolor=], [borderwidth=], [dtick=], [exponentformat=], [len=], [lenmode=], [minexponent=], [nticks=], [orientation=], [outlinecolor=], [outlinewidth=], [separatethousands=], [showexponent=], [showticklabels=], [showtickprefix=], [showticksuffix=], [thickness=], [thicknessmode=], [tick0=], [tickangle=], [tickcolor=], [tickfont=], [tickformat=], [tickformatstop=], [ticklabeloverflow=], [ticklabelposition=], [ticklabelstep=], [ticklen=], [tickmode=], [tickprefix=], [ticks=], [ticksuffix=], [ticktext=], [ticktextsrc=], [tickvals=], [tickvalssrc=], [tickwidth=], [title=], [x=], [xanchor=], [xpad=], [y=], [yanchor=], [ypad=]) → ColorBar

Create a new ‘ColorBar’ object

  • bgcolor - Sets the color of padded area.

  • bordercolor - Sets the axis line color.

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

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

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

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

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

  • minexponent - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.

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

  • orientation - Sets the orientation of the colorbar.

  • outlinecolor - Sets the axis line color.

  • outlinewidth - Sets the width (in px) of the axis line.

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

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

  • showticklabels - Determines whether or not the tick labels are drawn.

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

  • showticksuffix - Same as `showtickprefix` but for tick suffixes.

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

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

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

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

  • tickcolor - Sets the tick color.

  • tickfont - Sets the color bar's tick label font

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

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

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

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

  • ticklen - Sets the tick length (in px).

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

  • tickprefix - Sets a tick label prefix.

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

  • ticksuffix - Sets a tick label suffix.

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

  • ticktextsrc - Sets the source reference on Chart Studio Cloud for `ticktext`.

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

  • tickvalssrc - Sets the source reference on Chart Studio Cloud for `tickvals`.

  • tickwidth - Sets the tick width (in px).

  • x - Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*.

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

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

  • y - Sets the y position of the color bar (in plot fraction). Defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*.

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

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

plotly.graph_objs.choropleth.Hoverlabel([align=], [alignsrc=], [bgcolor=], [bgcolorsrc=], [bordercolor=], [bordercolorsrc=], [font=], [namelength=], [namelengthsrc=]) → Hoverlabel

Create a new ‘Hoverlabel’ object

  • 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

  • alignsrc - Sets the source reference on Chart Studio Cloud for `align`.

  • bgcolor - Sets the background color of the hover labels for this trace

  • bgcolorsrc - Sets the source reference on Chart Studio Cloud for `bgcolor`.

  • bordercolor - Sets the border color of the hover labels for this trace.

  • bordercolorsrc - Sets the source reference on Chart Studio Cloud for `bordercolor`.

  • font - Sets the font used in hover labels.

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

  • namelengthsrc - Sets the source reference on Chart Studio Cloud for `namelength`.

plotly.graph_objs.choropleth.Legendgrouptitle([font=], [text=]) → Legendgrouptitle

Create a new ‘Legendgrouptitle’ object

  • font - Sets this legend group's title font.

  • text - Sets the title of the legend group.

plotly.graph_objs.choropleth.Marker([line=], [opacity=], [opacitysrc=]) → Marker

Create a new ‘Marker’ object

  • opacity - Sets the opacity of the locations.

  • opacitysrc - Sets the source reference on Chart Studio Cloud for `opacity`.

plotly.graph_objs.choropleth.Selected([marker=]) → Selected

Create a new ‘Selected’ object

    plotly.graph_objs.choropleth.Stream([maxpoints=], [token=]) → Stream

    Create a new ‘Stream’ object

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

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

    plotly.graph_objs.choropleth.Transform() → Transform

    Create a new ‘Transform’ object

    plotly.graph_objs.choropleth.Unselected([marker=]) → Unselected

    Create a new ‘Unselected’ object

      Globals

      Do you still have questions?

      Our Community Forum is full of helpful information and Anvil experts.

      plotly.graph_objs.carpet.legendgrouptitle plotly.graph_objs.choropleth.colorbar

      plotly.graph_objs.choropleth