plotly.graph_objects.choroplethmap.colorbar package¶

class plotly.graph_objects.choroplethmap.colorbar.Tickfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

The ‘color’ 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 family¶

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

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

• A non-empty string

Returns

Return type

str

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

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

• Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns

Return type

Any

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

The ‘shadow’ 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 size¶

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

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

Returns

Return type

int|float

property style¶

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

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

• One of the following enumeration values:

  [‘normal’, ‘italic’]

Returns

Return type

Any

property textcase¶

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

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

• One of the following enumeration values:

  [‘normal’, ‘word caps’, ‘upper’, ‘lower’]

Returns

Return type

Any

property variant¶

Sets the variant of the font.

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

• One of the following enumeration values:

  [‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

Returns

Return type

Any

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is an integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

Returns

Return type

int

class plotly.graph_objects.choroplethmap.colorbar.Tickformatstop(arg=None, dtickrange=None, enabled=None, name=None, templateitemname=None, value=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property 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”

The ‘dtickrange’ property is an info array that may be specified as:

• a list or tuple of 2 elements where:

0. The ‘dtickrange[0]’ property accepts values of any type

1. The ‘dtickrange[1]’ property accepts values of any type

   list

property enabled¶

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

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

• A boolean value: True or False

Returns

Return type

bool

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

The ‘name’ 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 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.

The ‘templateitemname’ 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 value¶

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

The ‘value’ 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.choroplethmap.colorbar.Title(arg=None, font=None, side=None, text=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property font¶

Sets this color bar’s title font.

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

• An instance of plotly.graph_objects.choroplethmap.colorbar.title.Font

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

Returns

Return type

plotly.graph_objects.choroplethmap.colorbar.title.Font

property side¶

Determines the location of color bar’s title with respect to the color bar. Defaults to “top” when orientation is “v” and defaults to “right” when orientation is “h”.

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

• One of the following enumeration values:

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

Returns

Return type

Any

property text¶

Sets the title of the color bar.

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