GeezerVison is showing plotly.com — plotly.graph_objects.scattergeo package — 7.1.0 documentation
plotly.graph_objects.scattergeo package¶
-
class
plotly.graph_objects.scattergeo.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
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:
-
- 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:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.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:
-
- Returns
-
- Return type
bool
-
class
plotly.graph_objects.scattergeo.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
font¶
Sets this legend group’s title font.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.legendgrouptitle.Font
-
property
text¶
Sets the title of the legend group.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
class
plotly.graph_objects.scattergeo.Line(arg=None, color=None, dash=None, width=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
color¶
Sets the line 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
dash¶
Sets the dash style of lines. Set to a dash type string
(“solid”, “dot”, “dash”, “longdash”, “dashdot”, or
“longdashdot”) or a dash length list in px (eg
“5px,10px,2px,2px”).
- The ‘dash’ property is an enumeration that may be specified as:
- One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
- A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
- Returns
-
- Return type
str
-
property
width¶
Sets the line width (in px).
- The ‘width’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
class
plotly.graph_objects.scattergeo.Marker(arg=None, angle=None, angleref=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, gradient=None, line=None, opacity=None, reversescale=None, showscale=None, size=None, sizemin=None, sizemode=None, sizeref=None, standoff=None, symbol=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
angle¶
Sets the marker angle in respect to angleref.
The ‘angle’ property is a angle (in degrees) that may be
specified as a number between -180 and 180, or a list, numpy array or other iterable thereof.
Numeric values outside this range are converted to the equivalent value
(e.g. 270 is converted to -90).
- Returns
-
- Return type
int|float|numpy.ndarray
-
property
angleref¶
Sets the reference for marker angle. With “previous”, angle 0
points along the line from the previous point to this one. With
“up”, angle 0 points toward the top of the screen. With
“north”, angle 0 points north based on the current map
projection.
- The ‘angleref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘previous’, ‘up’, ‘north’]
- Returns
-
- Return type
Any
-
property
autocolorscale¶
Determines whether the colorscale is a default palette
(autocolorscale: true) or the palette determined by
marker.colorscale. Has an effect only if in marker.color is
set to a numerical array. In case colorscale is unspecified
or autocolorscale is true, the default palette will be chosen
according to whether numbers in the color array are all
positive, all negative or mixed.
- The ‘autocolorscale’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
cauto¶
Determines whether or not the color domain is computed with
respect to the input data (here in marker.color) or the
bounds set in marker.cmin and marker.cmax Has an effect
only if in marker.color is set to a numerical array. Defaults
to false when marker.cmin and marker.cmax are set by the
user.
- The ‘cauto’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
cmax¶
Sets the upper bound of the color domain. Has an effect only if
in marker.color is set to a numerical array. Value should
have the same units as in marker.color and if set,
marker.cmin must be set as well.
- The ‘cmax’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
cmid¶
Sets the mid-point of the color domain by scaling marker.cmin
and/or marker.cmax to be equidistant to this point. Has an
effect only if in marker.color is set to a numerical array.
Value should have the same units as in marker.color. Has no
effect when marker.cauto is false.
- The ‘cmid’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
cmin¶
Sets the lower bound of the color domain. Has an effect only if
in marker.color is set to a numerical array. Value should
have the same units as in marker.color and if set,
marker.cmax must be set as well.
- The ‘cmin’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
color¶
Sets the marker 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.cmin and marker.cmax if set.
- 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/ A number that will be interpreted as a color
according to scattergeo.marker.colorscale A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
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.
The ‘coloraxis’ property is an identifier of a particular
subplot, of type ‘coloraxis’, that may be specified as:
the string ‘coloraxis’ optionally followed by an integer >= 1
(e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
- Returns
-
- Return type
str
-
property
colorbar¶
The ‘colorbar’ property is an instance of ColorBar
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.marker.ColorBar
-
property
colorscale¶
Sets the colorscale. Has an effect only if in marker.color is
set to a numerical array. The colorscale must be an array
containing arrays mapping a normalized value to an rgb, rgba,
hex, hsl, 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
marker.cmin and marker.cmax. Alternatively, colorscale
may be a palette name string of the following list: Blackbody,B
luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic
,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
The ‘colorscale’ property is a colorscale and may be
specified as:
A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package. A list of 2-element lists where the first element is the
normalized color level value (starting at 0 and ending at 1),
and the second item is a valid color string.
(e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’,
‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’,
‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’,
‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’,
‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’,
‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’,
‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’,
‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’,
‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’,
‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’,
‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’,
‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’,
‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’,
‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
-
- Return type
str
-
property
gradient¶
The ‘gradient’ property is an instance of Gradient
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.marker.Gradient
-
property
line¶
The ‘line’ property is an instance of Line
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.marker.Line
-
property
opacity¶
Sets the marker opacity.
- 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
-
property
reversescale¶
Reverses the color mapping if true. Has an effect only if in
marker.color is set to a numerical array. If true,
marker.cmin will correspond to the last color in the array
and marker.cmax will correspond to the first color.
- The ‘reversescale’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showscale¶
Determines whether or not a colorbar is displayed for this
trace. Has an effect only if in marker.color is set to a
numerical array.
- The ‘showscale’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
size¶
Sets the marker size (in px).
- The ‘size’ property is a number and may be specified as:
An int or float in the interval [0, inf] A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|float|numpy.ndarray
-
property
sizemin¶
Has an effect only if marker.size is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
- The ‘sizemin’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
sizemode¶
Has an effect only if marker.size is set to a numerical
array. Sets the rule for which the data in size is converted
to pixels.
- The ‘sizemode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘diameter’, ‘area’]
- Returns
-
- Return type
Any
-
property
sizeref¶
Has an effect only if marker.size is set to a numerical
array. Sets the scale factor used to determine the rendered
size of marker points. Use with sizemin and sizemode.
- The ‘sizeref’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
standoff¶
Moves the marker away from the data point in the direction of
angle (in px). This can be useful for example if you have
another marker at this location and you want to point an
arrowhead marker at it.
- The ‘standoff’ property is a number and may be specified as:
An int or float in the interval [0, inf] A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|float|numpy.ndarray
-
property
symbol¶
Sets the marker symbol type. Adding 100 is equivalent to
appending “-open” to a symbol name. Adding 200 is equivalent to
appending “-dot” to a symbol name. Adding 300 is equivalent to
appending “-open-dot” or “dot-open” to a symbol name.
- The ‘symbol’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
class
plotly.graph_objects.scattergeo.Selected(arg=None, marker=None, textfont=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
marker¶
The ‘marker’ property is an instance of Marker
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.selected.Marker
-
property
textfont¶
The ‘textfont’ property is an instance of Textfont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.selected.Textfont
-
class
plotly.graph_objects.scattergeo.Textfont(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/ A list or array of any of the above
- Returns
-
- Return type
str|numpy.ndarray
-
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:
-
- Returns
-
- Return type
str|numpy.ndarray
-
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’) A list or array of the above
- Returns
-
- Return type
Any|numpy.ndarray
-
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 A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
str|numpy.ndarray
-
property
size¶
- The ‘size’ property is a number and may be specified as:
An int or float in the interval [1, inf] A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|float|numpy.ndarray
-
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:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
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:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
property
variant¶
Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
-
- Returns
-
- Return type
Any|numpy.ndarray
-
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’) A tuple, list, or one-dimensional numpy array of the above
- Returns
-
- Return type
int|numpy.ndarray
-
class
plotly.graph_objects.scattergeo.Unselected(arg=None, marker=None, textfont=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
marker¶
The ‘marker’ property is an instance of Marker
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.unselected.Marker
-
property
textfont¶
The ‘textfont’ property is an instance of Textfont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.scattergeo.unselected.Textfont
|
