1876 lines
65 KiB
Python
1876 lines
65 KiB
Python
# --- THIS FILE IS AUTO-GENERATED ---
|
|
# Modifications will be overwitten the next time code generation run.
|
|
|
|
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
|
import copy as _copy
|
|
import warnings
|
|
|
|
|
|
class Scattergeo(_BaseTraceType):
|
|
_parent_path_str = ""
|
|
_path_str = "scattergeo"
|
|
_valid_props = {
|
|
"connectgaps",
|
|
"customdata",
|
|
"customdatasrc",
|
|
"featureidkey",
|
|
"fill",
|
|
"fillcolor",
|
|
"geo",
|
|
"geojson",
|
|
"hoverinfo",
|
|
"hoverinfosrc",
|
|
"hoverlabel",
|
|
"hovertemplate",
|
|
"hovertemplatesrc",
|
|
"hovertext",
|
|
"hovertextsrc",
|
|
"ids",
|
|
"idssrc",
|
|
"lat",
|
|
"latsrc",
|
|
"legend",
|
|
"legendgroup",
|
|
"legendgrouptitle",
|
|
"legendrank",
|
|
"legendwidth",
|
|
"line",
|
|
"locationmode",
|
|
"locations",
|
|
"locationssrc",
|
|
"lon",
|
|
"lonsrc",
|
|
"marker",
|
|
"meta",
|
|
"metasrc",
|
|
"mode",
|
|
"name",
|
|
"opacity",
|
|
"selected",
|
|
"selectedpoints",
|
|
"showlegend",
|
|
"stream",
|
|
"text",
|
|
"textfont",
|
|
"textposition",
|
|
"textpositionsrc",
|
|
"textsrc",
|
|
"texttemplate",
|
|
"texttemplatesrc",
|
|
"type",
|
|
"uid",
|
|
"uirevision",
|
|
"unselected",
|
|
"visible",
|
|
}
|
|
|
|
@property
|
|
def connectgaps(self):
|
|
"""
|
|
Determines whether or not gaps (i.e. {nan} or missing values)
|
|
in the provided data arrays are connected.
|
|
|
|
The 'connectgaps' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["connectgaps"]
|
|
|
|
@connectgaps.setter
|
|
def connectgaps(self, val):
|
|
self["connectgaps"] = val
|
|
|
|
@property
|
|
def customdata(self):
|
|
"""
|
|
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
|
|
|
|
The 'customdata' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["customdata"]
|
|
|
|
@customdata.setter
|
|
def customdata(self, val):
|
|
self["customdata"] = val
|
|
|
|
@property
|
|
def customdatasrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`customdata`.
|
|
|
|
The 'customdatasrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["customdatasrc"]
|
|
|
|
@customdatasrc.setter
|
|
def customdatasrc(self, val):
|
|
self["customdatasrc"] = val
|
|
|
|
@property
|
|
def featureidkey(self):
|
|
"""
|
|
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".
|
|
|
|
The 'featureidkey' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["featureidkey"]
|
|
|
|
@featureidkey.setter
|
|
def featureidkey(self, val):
|
|
self["featureidkey"] = val
|
|
|
|
@property
|
|
def fill(self):
|
|
"""
|
|
Sets the area to fill with a solid color. Use with `fillcolor`
|
|
if not "none". "toself" connects the endpoints of the trace (or
|
|
each segment of the trace if it has gaps) into a closed shape.
|
|
|
|
The 'fill' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['none', 'toself']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["fill"]
|
|
|
|
@fill.setter
|
|
def fill(self, val):
|
|
self["fill"] = val
|
|
|
|
@property
|
|
def fillcolor(self):
|
|
"""
|
|
Sets the fill color. Defaults to a half-transparent variant of
|
|
the line color, marker color, or marker line color, whichever
|
|
is available.
|
|
|
|
The 'fillcolor' 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: see https://plotly.com/python/css-colors/ for a list
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["fillcolor"]
|
|
|
|
@fillcolor.setter
|
|
def fillcolor(self, val):
|
|
self["fillcolor"] = val
|
|
|
|
@property
|
|
def geo(self):
|
|
"""
|
|
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.
|
|
|
|
The 'geo' property is an identifier of a particular
|
|
subplot, of type 'geo', that may be specified as the string 'geo'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["geo"]
|
|
|
|
@geo.setter
|
|
def geo(self, val):
|
|
self["geo"] = val
|
|
|
|
@property
|
|
def geojson(self):
|
|
"""
|
|
Sets optional GeoJSON data associated with this trace. If not
|
|
given, the features on the base map are used when `locations`
|
|
is set. 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".
|
|
|
|
The 'geojson' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["geojson"]
|
|
|
|
@geojson.setter
|
|
def geojson(self, val):
|
|
self["geojson"] = val
|
|
|
|
@property
|
|
def hoverinfo(self):
|
|
"""
|
|
Determines which trace information appear 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.
|
|
|
|
The 'hoverinfo' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['lon', 'lat', 'location', 'text', 'name'] joined with '+' characters
|
|
(e.g. 'lon+lat')
|
|
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
|
- A list or array of the above
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["hoverinfo"]
|
|
|
|
@hoverinfo.setter
|
|
def hoverinfo(self, val):
|
|
self["hoverinfo"] = val
|
|
|
|
@property
|
|
def hoverinfosrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hoverinfo`.
|
|
|
|
The 'hoverinfosrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["hoverinfosrc"]
|
|
|
|
@hoverinfosrc.setter
|
|
def hoverinfosrc(self, val):
|
|
self["hoverinfosrc"] = val
|
|
|
|
@property
|
|
def hoverlabel(self):
|
|
"""
|
|
The 'hoverlabel' property is an instance of Hoverlabel
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel`
|
|
- A dict of string/value properties that will be passed
|
|
to the Hoverlabel constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Hoverlabel
|
|
"""
|
|
return self["hoverlabel"]
|
|
|
|
@hoverlabel.setter
|
|
def hoverlabel(self, val):
|
|
self["hoverlabel"] = val
|
|
|
|
@property
|
|
def hovertemplate(self):
|
|
"""
|
|
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. 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, every 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>`.
|
|
|
|
The 'hovertemplate' 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
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["hovertemplate"]
|
|
|
|
@hovertemplate.setter
|
|
def hovertemplate(self, val):
|
|
self["hovertemplate"] = val
|
|
|
|
@property
|
|
def hovertemplatesrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
|
|
The 'hovertemplatesrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["hovertemplatesrc"]
|
|
|
|
@hovertemplatesrc.setter
|
|
def hovertemplatesrc(self, val):
|
|
self["hovertemplatesrc"] = val
|
|
|
|
@property
|
|
def hovertext(self):
|
|
"""
|
|
Sets hover text elements associated with each (lon,lat) pair or
|
|
item in `locations`. If a single string, the same string
|
|
appears over all the data points. If an array of string, the
|
|
items are mapped in order to the this trace's (lon,lat) or
|
|
`locations` coordinates. To be seen, trace `hoverinfo` must
|
|
contain a "text" flag.
|
|
|
|
The 'hovertext' 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
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["hovertext"]
|
|
|
|
@hovertext.setter
|
|
def hovertext(self, val):
|
|
self["hovertext"] = val
|
|
|
|
@property
|
|
def hovertextsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
|
|
The 'hovertextsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["hovertextsrc"]
|
|
|
|
@hovertextsrc.setter
|
|
def hovertextsrc(self, val):
|
|
self["hovertextsrc"] = val
|
|
|
|
@property
|
|
def ids(self):
|
|
"""
|
|
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.
|
|
|
|
The 'ids' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["ids"]
|
|
|
|
@ids.setter
|
|
def ids(self, val):
|
|
self["ids"] = val
|
|
|
|
@property
|
|
def idssrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `ids`.
|
|
|
|
The 'idssrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["idssrc"]
|
|
|
|
@idssrc.setter
|
|
def idssrc(self, val):
|
|
self["idssrc"] = val
|
|
|
|
@property
|
|
def lat(self):
|
|
"""
|
|
Sets the latitude coordinates (in degrees North).
|
|
|
|
The 'lat' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["lat"]
|
|
|
|
@lat.setter
|
|
def lat(self, val):
|
|
self["lat"] = val
|
|
|
|
@property
|
|
def latsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `lat`.
|
|
|
|
The 'latsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["latsrc"]
|
|
|
|
@latsrc.setter
|
|
def latsrc(self, val):
|
|
self["latsrc"] = val
|
|
|
|
@property
|
|
def legend(self):
|
|
"""
|
|
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.
|
|
|
|
The 'legend' property is an identifier of a particular
|
|
subplot, of type 'legend', that may be specified as the string 'legend'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["legend"]
|
|
|
|
@legend.setter
|
|
def legend(self, val):
|
|
self["legend"] = val
|
|
|
|
@property
|
|
def legendgroup(self):
|
|
"""
|
|
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.
|
|
|
|
The 'legendgroup' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["legendgroup"]
|
|
|
|
@legendgroup.setter
|
|
def legendgroup(self, val):
|
|
self["legendgroup"] = val
|
|
|
|
@property
|
|
def legendgrouptitle(self):
|
|
"""
|
|
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Legendgrouptitle`
|
|
- A dict of string/value properties that will be passed
|
|
to the Legendgrouptitle constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Legendgrouptitle
|
|
"""
|
|
return self["legendgrouptitle"]
|
|
|
|
@legendgrouptitle.setter
|
|
def legendgrouptitle(self, val):
|
|
self["legendgrouptitle"] = val
|
|
|
|
@property
|
|
def legendrank(self):
|
|
"""
|
|
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.
|
|
|
|
The 'legendrank' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["legendrank"]
|
|
|
|
@legendrank.setter
|
|
def legendrank(self, val):
|
|
self["legendrank"] = val
|
|
|
|
@property
|
|
def legendwidth(self):
|
|
"""
|
|
Sets the width (in px or fraction) of the legend for this
|
|
trace.
|
|
|
|
The 'legendwidth' property is a number and may be specified as:
|
|
- An int or float in the interval [0, inf]
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["legendwidth"]
|
|
|
|
@legendwidth.setter
|
|
def legendwidth(self, val):
|
|
self["legendwidth"] = val
|
|
|
|
@property
|
|
def line(self):
|
|
"""
|
|
The 'line' property is an instance of Line
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Line`
|
|
- A dict of string/value properties that will be passed
|
|
to the Line constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Line
|
|
"""
|
|
return self["line"]
|
|
|
|
@line.setter
|
|
def line(self, val):
|
|
self["line"] = val
|
|
|
|
@property
|
|
def locationmode(self):
|
|
"""
|
|
The library used by the *country names* `locationmode` option
|
|
is changing in an upcoming version. Country names in existing
|
|
plots may not work in the new version. 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.
|
|
|
|
The 'locationmode' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['ISO-3', 'USA-states', 'country names', 'geojson-id']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["locationmode"]
|
|
|
|
@locationmode.setter
|
|
def locationmode(self, val):
|
|
self["locationmode"] = val
|
|
|
|
@property
|
|
def locations(self):
|
|
"""
|
|
Sets the coordinates via location IDs or names. Coordinates
|
|
correspond to the centroid of each location given. See
|
|
`locationmode` for more info.
|
|
|
|
The 'locations' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["locations"]
|
|
|
|
@locations.setter
|
|
def locations(self, val):
|
|
self["locations"] = val
|
|
|
|
@property
|
|
def locationssrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`locations`.
|
|
|
|
The 'locationssrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["locationssrc"]
|
|
|
|
@locationssrc.setter
|
|
def locationssrc(self, val):
|
|
self["locationssrc"] = val
|
|
|
|
@property
|
|
def lon(self):
|
|
"""
|
|
Sets the longitude coordinates (in degrees East).
|
|
|
|
The 'lon' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["lon"]
|
|
|
|
@lon.setter
|
|
def lon(self, val):
|
|
self["lon"] = val
|
|
|
|
@property
|
|
def lonsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `lon`.
|
|
|
|
The 'lonsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["lonsrc"]
|
|
|
|
@lonsrc.setter
|
|
def lonsrc(self, val):
|
|
self["lonsrc"] = val
|
|
|
|
@property
|
|
def marker(self):
|
|
"""
|
|
The 'marker' property is an instance of Marker
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Marker`
|
|
- A dict of string/value properties that will be passed
|
|
to the Marker constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Marker
|
|
"""
|
|
return self["marker"]
|
|
|
|
@marker.setter
|
|
def marker(self, val):
|
|
self["marker"] = val
|
|
|
|
@property
|
|
def meta(self):
|
|
"""
|
|
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.
|
|
|
|
The 'meta' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["meta"]
|
|
|
|
@meta.setter
|
|
def meta(self, val):
|
|
self["meta"] = val
|
|
|
|
@property
|
|
def metasrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `meta`.
|
|
|
|
The 'metasrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["metasrc"]
|
|
|
|
@metasrc.setter
|
|
def metasrc(self, val):
|
|
self["metasrc"] = val
|
|
|
|
@property
|
|
def mode(self):
|
|
"""
|
|
Determines the drawing mode for this scatter trace. If the
|
|
provided `mode` includes "text" then the `text` elements appear
|
|
at the coordinates. Otherwise, the `text` elements appear on
|
|
hover. If there are less than 20 points and the trace is not
|
|
stacked then the default is "lines+markers". Otherwise,
|
|
"lines".
|
|
|
|
The 'mode' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['lines', 'markers', 'text'] joined with '+' characters
|
|
(e.g. 'lines+markers')
|
|
OR exactly one of ['none'] (e.g. 'none')
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["mode"]
|
|
|
|
@mode.setter
|
|
def mode(self, val):
|
|
self["mode"] = val
|
|
|
|
@property
|
|
def name(self):
|
|
"""
|
|
Sets the trace name. The trace name appears as the legend item
|
|
and on hover.
|
|
|
|
The 'name' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["name"]
|
|
|
|
@name.setter
|
|
def name(self, val):
|
|
self["name"] = val
|
|
|
|
@property
|
|
def opacity(self):
|
|
"""
|
|
Sets the opacity of the trace.
|
|
|
|
The 'opacity' property is a number and may be specified as:
|
|
- An int or float in the interval [0, 1]
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["opacity"]
|
|
|
|
@opacity.setter
|
|
def opacity(self, val):
|
|
self["opacity"] = val
|
|
|
|
@property
|
|
def selected(self):
|
|
"""
|
|
The 'selected' property is an instance of Selected
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Selected`
|
|
- A dict of string/value properties that will be passed
|
|
to the Selected constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Selected
|
|
"""
|
|
return self["selected"]
|
|
|
|
@selected.setter
|
|
def selected(self, val):
|
|
self["selected"] = val
|
|
|
|
@property
|
|
def selectedpoints(self):
|
|
"""
|
|
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.
|
|
|
|
The 'selectedpoints' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["selectedpoints"]
|
|
|
|
@selectedpoints.setter
|
|
def selectedpoints(self, val):
|
|
self["selectedpoints"] = val
|
|
|
|
@property
|
|
def showlegend(self):
|
|
"""
|
|
Determines whether or not an item corresponding to this trace
|
|
is shown in the legend.
|
|
|
|
The 'showlegend' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["showlegend"]
|
|
|
|
@showlegend.setter
|
|
def showlegend(self, val):
|
|
self["showlegend"] = val
|
|
|
|
@property
|
|
def stream(self):
|
|
"""
|
|
The 'stream' property is an instance of Stream
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Stream`
|
|
- A dict of string/value properties that will be passed
|
|
to the Stream constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Stream
|
|
"""
|
|
return self["stream"]
|
|
|
|
@stream.setter
|
|
def stream(self, val):
|
|
self["stream"] = val
|
|
|
|
@property
|
|
def text(self):
|
|
"""
|
|
Sets text elements associated with each (lon,lat) pair or item
|
|
in `locations`. If a single string, the same string appears
|
|
over all the data points. If an array of string, the items are
|
|
mapped in order to the this trace's (lon,lat) or `locations`
|
|
coordinates. If trace `hoverinfo` contains a "text" flag and
|
|
"hovertext" is not set, these elements will be seen in the
|
|
hover labels.
|
|
|
|
The 'text' 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
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["text"]
|
|
|
|
@text.setter
|
|
def text(self, val):
|
|
self["text"] = val
|
|
|
|
@property
|
|
def textfont(self):
|
|
"""
|
|
Sets the text font.
|
|
|
|
The 'textfont' property is an instance of Textfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Textfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Textfont constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Textfont
|
|
"""
|
|
return self["textfont"]
|
|
|
|
@textfont.setter
|
|
def textfont(self, val):
|
|
self["textfont"] = val
|
|
|
|
@property
|
|
def textposition(self):
|
|
"""
|
|
Sets the positions of the `text` elements with respects to the
|
|
(x,y) coordinates.
|
|
|
|
The 'textposition' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['top left', 'top center', 'top right', 'middle left',
|
|
'middle center', 'middle right', 'bottom left', 'bottom
|
|
center', 'bottom right']
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["textposition"]
|
|
|
|
@textposition.setter
|
|
def textposition(self, val):
|
|
self["textposition"] = val
|
|
|
|
@property
|
|
def textpositionsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`textposition`.
|
|
|
|
The 'textpositionsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["textpositionsrc"]
|
|
|
|
@textpositionsrc.setter
|
|
def textpositionsrc(self, val):
|
|
self["textpositionsrc"] = val
|
|
|
|
@property
|
|
def textsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `text`.
|
|
|
|
The 'textsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["textsrc"]
|
|
|
|
@textsrc.setter
|
|
def textsrc(self, val):
|
|
self["textsrc"] = val
|
|
|
|
@property
|
|
def texttemplate(self):
|
|
"""
|
|
Template string used for rendering the information text that
|
|
appear on points. Note that this will override `textinfo`.
|
|
Variables are inserted using %{variable}, for example "y:
|
|
%{y}". 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. Every attributes that can be specified per-
|
|
point (the ones that are `arrayOk: true`) are available.
|
|
Finally, the template string has access to variables `lat`,
|
|
`lon`, `location` and `text`.
|
|
|
|
The 'texttemplate' 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
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["texttemplate"]
|
|
|
|
@texttemplate.setter
|
|
def texttemplate(self, val):
|
|
self["texttemplate"] = val
|
|
|
|
@property
|
|
def texttemplatesrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
|
|
The 'texttemplatesrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["texttemplatesrc"]
|
|
|
|
@texttemplatesrc.setter
|
|
def texttemplatesrc(self, val):
|
|
self["texttemplatesrc"] = val
|
|
|
|
@property
|
|
def uid(self):
|
|
"""
|
|
Assign an id to this trace, Use this to provide object
|
|
constancy between traces during animations and transitions.
|
|
|
|
The 'uid' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["uid"]
|
|
|
|
@uid.setter
|
|
def uid(self, val):
|
|
self["uid"] = val
|
|
|
|
@property
|
|
def uirevision(self):
|
|
"""
|
|
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.
|
|
|
|
The 'uirevision' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["uirevision"]
|
|
|
|
@uirevision.setter
|
|
def uirevision(self, val):
|
|
self["uirevision"] = val
|
|
|
|
@property
|
|
def unselected(self):
|
|
"""
|
|
The 'unselected' property is an instance of Unselected
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.scattergeo.Unselected`
|
|
- A dict of string/value properties that will be passed
|
|
to the Unselected constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.scattergeo.Unselected
|
|
"""
|
|
return self["unselected"]
|
|
|
|
@unselected.setter
|
|
def unselected(self, val):
|
|
self["unselected"] = val
|
|
|
|
@property
|
|
def visible(self):
|
|
"""
|
|
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).
|
|
|
|
The 'visible' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
[True, False, 'legendonly']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["visible"]
|
|
|
|
@visible.setter
|
|
def visible(self, val):
|
|
self["visible"] = val
|
|
|
|
@property
|
|
def type(self):
|
|
return self._props["type"]
|
|
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
connectgaps
|
|
Determines whether or not gaps (i.e. {nan} or missing
|
|
values) in the provided data arrays are connected.
|
|
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
|
|
customdatasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`customdata`.
|
|
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".
|
|
fill
|
|
Sets the area to fill with a solid color. Use with
|
|
`fillcolor` if not "none". "toself" connects the
|
|
endpoints of the trace (or each segment of the trace if
|
|
it has gaps) into a closed shape.
|
|
fillcolor
|
|
Sets the fill color. Defaults to a half-transparent
|
|
variant of the line color, marker color, or marker line
|
|
color, whichever is available.
|
|
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
|
|
when `locations` is set. 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 which trace information appear 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.
|
|
hoverinfosrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hoverinfo`.
|
|
hoverlabel
|
|
:class:`plotly.graph_objects.scattergeo.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. 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, every 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>`.
|
|
hovertemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
hovertext
|
|
Sets hover text elements associated with each (lon,lat)
|
|
pair or item in `locations`. If a single string, the
|
|
same string appears over all the data points. If an
|
|
array of string, the items are mapped in order to the
|
|
this trace's (lon,lat) or `locations` coordinates. To
|
|
be seen, trace `hoverinfo` must contain a "text" flag.
|
|
hovertextsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
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.
|
|
idssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`ids`.
|
|
lat
|
|
Sets the latitude coordinates (in degrees North).
|
|
latsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`lat`.
|
|
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
|
|
:class:`plotly.graph_objects.scattergeo.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.
|
|
line
|
|
:class:`plotly.graph_objects.scattergeo.Line` instance
|
|
or dict with compatible properties
|
|
locationmode
|
|
The library used by the *country names* `locationmode`
|
|
option is changing in an upcoming version. Country
|
|
names in existing plots may not work in the new
|
|
version. 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.
|
|
locations
|
|
Sets the coordinates via location IDs or names.
|
|
Coordinates correspond to the centroid of each location
|
|
given. See `locationmode` for more info.
|
|
locationssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`locations`.
|
|
lon
|
|
Sets the longitude coordinates (in degrees East).
|
|
lonsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`lon`.
|
|
marker
|
|
:class:`plotly.graph_objects.scattergeo.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.
|
|
metasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`meta`.
|
|
mode
|
|
Determines the drawing mode for this scatter trace. If
|
|
the provided `mode` includes "text" then the `text`
|
|
elements appear at the coordinates. Otherwise, the
|
|
`text` elements appear on hover. If there are less than
|
|
20 points and the trace is not stacked then the default
|
|
is "lines+markers". Otherwise, "lines".
|
|
name
|
|
Sets the trace name. The trace name appears as the
|
|
legend item and on hover.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
selected
|
|
:class:`plotly.graph_objects.scattergeo.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.
|
|
stream
|
|
:class:`plotly.graph_objects.scattergeo.Stream`
|
|
instance or dict with compatible properties
|
|
text
|
|
Sets text elements associated with each (lon,lat) pair
|
|
or item in `locations`. If a single string, the same
|
|
string appears over all the data points. If an array of
|
|
string, the items are mapped in order to the this
|
|
trace's (lon,lat) or `locations` coordinates. If trace
|
|
`hoverinfo` contains a "text" flag and "hovertext" is
|
|
not set, these elements will be seen in the hover
|
|
labels.
|
|
textfont
|
|
Sets the text font.
|
|
textposition
|
|
Sets the positions of the `text` elements with respects
|
|
to the (x,y) coordinates.
|
|
textpositionsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`textposition`.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
texttemplate
|
|
Template string used for rendering the information text
|
|
that appear on points. Note that this will override
|
|
`textinfo`. Variables are inserted using %{variable},
|
|
for example "y: %{y}". 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. Every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `lat`, `lon`, `location` and `text`.
|
|
texttemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
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
|
|
:class:`plotly.graph_objects.scattergeo.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).
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
connectgaps=None,
|
|
customdata=None,
|
|
customdatasrc=None,
|
|
featureidkey=None,
|
|
fill=None,
|
|
fillcolor=None,
|
|
geo=None,
|
|
geojson=None,
|
|
hoverinfo=None,
|
|
hoverinfosrc=None,
|
|
hoverlabel=None,
|
|
hovertemplate=None,
|
|
hovertemplatesrc=None,
|
|
hovertext=None,
|
|
hovertextsrc=None,
|
|
ids=None,
|
|
idssrc=None,
|
|
lat=None,
|
|
latsrc=None,
|
|
legend=None,
|
|
legendgroup=None,
|
|
legendgrouptitle=None,
|
|
legendrank=None,
|
|
legendwidth=None,
|
|
line=None,
|
|
locationmode=None,
|
|
locations=None,
|
|
locationssrc=None,
|
|
lon=None,
|
|
lonsrc=None,
|
|
marker=None,
|
|
meta=None,
|
|
metasrc=None,
|
|
mode=None,
|
|
name=None,
|
|
opacity=None,
|
|
selected=None,
|
|
selectedpoints=None,
|
|
showlegend=None,
|
|
stream=None,
|
|
text=None,
|
|
textfont=None,
|
|
textposition=None,
|
|
textpositionsrc=None,
|
|
textsrc=None,
|
|
texttemplate=None,
|
|
texttemplatesrc=None,
|
|
uid=None,
|
|
uirevision=None,
|
|
unselected=None,
|
|
visible=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Scattergeo object
|
|
|
|
The data visualized as scatter point or lines on a geographic
|
|
map is provided either by longitude/latitude pairs in `lon` and
|
|
`lat` respectively or by geographic location IDs or names in
|
|
`locations`.
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Scattergeo`
|
|
connectgaps
|
|
Determines whether or not gaps (i.e. {nan} or missing
|
|
values) in the provided data arrays are connected.
|
|
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
|
|
customdatasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`customdata`.
|
|
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".
|
|
fill
|
|
Sets the area to fill with a solid color. Use with
|
|
`fillcolor` if not "none". "toself" connects the
|
|
endpoints of the trace (or each segment of the trace if
|
|
it has gaps) into a closed shape.
|
|
fillcolor
|
|
Sets the fill color. Defaults to a half-transparent
|
|
variant of the line color, marker color, or marker line
|
|
color, whichever is available.
|
|
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
|
|
when `locations` is set. 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 which trace information appear 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.
|
|
hoverinfosrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hoverinfo`.
|
|
hoverlabel
|
|
:class:`plotly.graph_objects.scattergeo.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. 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, every 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>`.
|
|
hovertemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
hovertext
|
|
Sets hover text elements associated with each (lon,lat)
|
|
pair or item in `locations`. If a single string, the
|
|
same string appears over all the data points. If an
|
|
array of string, the items are mapped in order to the
|
|
this trace's (lon,lat) or `locations` coordinates. To
|
|
be seen, trace `hoverinfo` must contain a "text" flag.
|
|
hovertextsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
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.
|
|
idssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`ids`.
|
|
lat
|
|
Sets the latitude coordinates (in degrees North).
|
|
latsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`lat`.
|
|
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
|
|
:class:`plotly.graph_objects.scattergeo.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.
|
|
line
|
|
:class:`plotly.graph_objects.scattergeo.Line` instance
|
|
or dict with compatible properties
|
|
locationmode
|
|
The library used by the *country names* `locationmode`
|
|
option is changing in an upcoming version. Country
|
|
names in existing plots may not work in the new
|
|
version. 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.
|
|
locations
|
|
Sets the coordinates via location IDs or names.
|
|
Coordinates correspond to the centroid of each location
|
|
given. See `locationmode` for more info.
|
|
locationssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`locations`.
|
|
lon
|
|
Sets the longitude coordinates (in degrees East).
|
|
lonsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`lon`.
|
|
marker
|
|
:class:`plotly.graph_objects.scattergeo.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.
|
|
metasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`meta`.
|
|
mode
|
|
Determines the drawing mode for this scatter trace. If
|
|
the provided `mode` includes "text" then the `text`
|
|
elements appear at the coordinates. Otherwise, the
|
|
`text` elements appear on hover. If there are less than
|
|
20 points and the trace is not stacked then the default
|
|
is "lines+markers". Otherwise, "lines".
|
|
name
|
|
Sets the trace name. The trace name appears as the
|
|
legend item and on hover.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
selected
|
|
:class:`plotly.graph_objects.scattergeo.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.
|
|
stream
|
|
:class:`plotly.graph_objects.scattergeo.Stream`
|
|
instance or dict with compatible properties
|
|
text
|
|
Sets text elements associated with each (lon,lat) pair
|
|
or item in `locations`. If a single string, the same
|
|
string appears over all the data points. If an array of
|
|
string, the items are mapped in order to the this
|
|
trace's (lon,lat) or `locations` coordinates. If trace
|
|
`hoverinfo` contains a "text" flag and "hovertext" is
|
|
not set, these elements will be seen in the hover
|
|
labels.
|
|
textfont
|
|
Sets the text font.
|
|
textposition
|
|
Sets the positions of the `text` elements with respects
|
|
to the (x,y) coordinates.
|
|
textpositionsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`textposition`.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
texttemplate
|
|
Template string used for rendering the information text
|
|
that appear on points. Note that this will override
|
|
`textinfo`. Variables are inserted using %{variable},
|
|
for example "y: %{y}". 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. Every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `lat`, `lon`, `location` and `text`.
|
|
texttemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
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
|
|
:class:`plotly.graph_objects.scattergeo.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).
|
|
|
|
Returns
|
|
-------
|
|
Scattergeo
|
|
"""
|
|
super().__init__("scattergeo")
|
|
if "_parent" in kwargs:
|
|
self._parent = kwargs["_parent"]
|
|
return
|
|
|
|
if arg is None:
|
|
arg = {}
|
|
elif isinstance(arg, self.__class__):
|
|
arg = arg.to_plotly_json()
|
|
elif isinstance(arg, dict):
|
|
arg = _copy.copy(arg)
|
|
else:
|
|
raise ValueError("""\
|
|
The first argument to the plotly.graph_objs.Scattergeo
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Scattergeo`""")
|
|
|
|
if locationmode == "country names" and kwargs.get("_validate"):
|
|
warnings.warn(
|
|
"The library used by the *country names* `locationmode` option is changing in an upcoming version. "
|
|
"Country names in existing plots may not work in the new version. "
|
|
"To ensure consistent behavior, consider setting `locationmode` to *ISO-3*.",
|
|
DeprecationWarning,
|
|
stacklevel=5,
|
|
)
|
|
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
self._set_property("connectgaps", arg, connectgaps)
|
|
self._set_property("customdata", arg, customdata)
|
|
self._set_property("customdatasrc", arg, customdatasrc)
|
|
self._set_property("featureidkey", arg, featureidkey)
|
|
self._set_property("fill", arg, fill)
|
|
self._set_property("fillcolor", arg, fillcolor)
|
|
self._set_property("geo", arg, geo)
|
|
self._set_property("geojson", arg, geojson)
|
|
self._set_property("hoverinfo", arg, hoverinfo)
|
|
self._set_property("hoverinfosrc", arg, hoverinfosrc)
|
|
self._set_property("hoverlabel", arg, hoverlabel)
|
|
self._set_property("hovertemplate", arg, hovertemplate)
|
|
self._set_property("hovertemplatesrc", arg, hovertemplatesrc)
|
|
self._set_property("hovertext", arg, hovertext)
|
|
self._set_property("hovertextsrc", arg, hovertextsrc)
|
|
self._set_property("ids", arg, ids)
|
|
self._set_property("idssrc", arg, idssrc)
|
|
self._set_property("lat", arg, lat)
|
|
self._set_property("latsrc", arg, latsrc)
|
|
self._set_property("legend", arg, legend)
|
|
self._set_property("legendgroup", arg, legendgroup)
|
|
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
|
self._set_property("legendrank", arg, legendrank)
|
|
self._set_property("legendwidth", arg, legendwidth)
|
|
self._set_property("line", arg, line)
|
|
self._set_property("locationmode", arg, locationmode)
|
|
self._set_property("locations", arg, locations)
|
|
self._set_property("locationssrc", arg, locationssrc)
|
|
self._set_property("lon", arg, lon)
|
|
self._set_property("lonsrc", arg, lonsrc)
|
|
self._set_property("marker", arg, marker)
|
|
self._set_property("meta", arg, meta)
|
|
self._set_property("metasrc", arg, metasrc)
|
|
self._set_property("mode", arg, mode)
|
|
self._set_property("name", arg, name)
|
|
self._set_property("opacity", arg, opacity)
|
|
self._set_property("selected", arg, selected)
|
|
self._set_property("selectedpoints", arg, selectedpoints)
|
|
self._set_property("showlegend", arg, showlegend)
|
|
self._set_property("stream", arg, stream)
|
|
self._set_property("text", arg, text)
|
|
self._set_property("textfont", arg, textfont)
|
|
self._set_property("textposition", arg, textposition)
|
|
self._set_property("textpositionsrc", arg, textpositionsrc)
|
|
self._set_property("textsrc", arg, textsrc)
|
|
self._set_property("texttemplate", arg, texttemplate)
|
|
self._set_property("texttemplatesrc", arg, texttemplatesrc)
|
|
self._set_property("uid", arg, uid)
|
|
self._set_property("uirevision", arg, uirevision)
|
|
self._set_property("unselected", arg, unselected)
|
|
self._set_property("visible", arg, visible)
|
|
|
|
self._props["type"] = "scattergeo"
|
|
arg.pop("type", None)
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
self._skip_invalid = False
|