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

class Scattermap(_BaseTraceType):

_parent_path_str = ""

_path_str = "scattermap"

_valid_props = {

"below",

"cluster",

"connectgaps",

"customdata",

"customdatasrc",

"fill",

"fillcolor",

"hoverinfo",

"hoverinfosrc",

"hoverlabel",

"hovertemplate",

"hovertemplatefallback",

"hovertemplatesrc",

"hovertext",

"hovertextsrc",

"ids",

"idssrc",

"lat",

"latsrc",

"legend",

"legendgroup",

"legendgrouptitle",

"legendrank",

"legendwidth",

"line",

"lon",

"lonsrc",

"marker",

"meta",

"metasrc",

"mode",

"name",

"opacity",

"selected",

"selectedpoints",

"showlegend",

"stream",

"subplot",

"text",

"textfont",

"textposition",

"textsrc",

"texttemplate",

"texttemplatefallback",

"texttemplatesrc",

"type",

"uid",

"uirevision",

"unselected",

"visible",

}

@property

def below(self):

"""

Determines if this scattermap trace's layers are to be inserted

before the layer with the specified ID. By default, scattermap

layers are inserted above all the base layers. To place the

scattermap layers above every other layer, set `below` to "''".

The 'below' property is a string and must be specified as:

- A string

- A number that will be converted to a string

Returns

-------

str

"""

return self["below"]

@below.setter

def below(self, val):

self["below"] = val

@property

def cluster(self):

"""

The 'cluster' property is an instance of Cluster

that may be specified as:

- An instance of :class:`plotly.graph_objs.scattermap.Cluster`

- A dict of string/value properties that will be passed

to the Cluster constructor

Returns

-------

plotly.graph_objs.scattermap.Cluster

"""

return self["cluster"]

@cluster.setter

def cluster(self, val):

self["cluster"] = val

@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 is a boolean and must be specified as:

- A boolean value: 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 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 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', '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.scattermap.Hoverlabel`

- A dict of string/value properties that will be passed

to the Hoverlabel constructor

Returns

-------

plotly.graph_objs.scattermap.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. Variables that can't be found will be

replaced with the specifier. For example, a template of "data:

%{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1

and y is missing. Variables with an undefined value will be

replaced with the fallback value. The variables available in

`hovertemplate` are the ones emitted as event data described at

this link https://plotly.com/javascript/plotlyjs-events/#event-

data. Additionally, all attributes that can be specified per-

point (the ones that are `arrayOk: true`) are available.

Anything contained in tag `<extra>` is displayed in the

secondary box, for example `<extra>%{fullData.name}</extra>`.

To hide the secondary box completely, use an empty tag

`<extra></extra>`.

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 hovertemplatefallback(self):

"""

Fallback string that's displayed when a variable referenced in

a template is missing. If the boolean value 'false' is passed

in, the specifier with the missing variable will be displayed.

The 'hovertemplatefallback' property accepts values of any type

Returns

-------

Any

"""

return self["hovertemplatefallback"]

@hovertemplatefallback.setter

def hovertemplatefallback(self, val):

self["hovertemplatefallback"] = 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 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) 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.scattermap.Legendgrouptitle`

- A dict of string/value properties that will be passed

to the Legendgrouptitle constructor

Returns

-------

plotly.graph_objs.scattermap.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.scattermap.Line`

- A dict of string/value properties that will be passed

to the Line constructor

Returns

-------

plotly.graph_objs.scattermap.Line

"""

return self["line"]

@line.setter

def line(self, val):

self["line"] = 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.scattermap.Marker`

- A dict of string/value properties that will be passed

to the Marker constructor

Returns

-------

plotly.graph_objs.scattermap.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.

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.scattermap.Selected`

- A dict of string/value properties that will be passed

to the Selected constructor

Returns

-------

plotly.graph_objs.scattermap.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 is a boolean and must be specified as:

- A boolean value: 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.scattermap.Stream`

- A dict of string/value properties that will be passed

to the Stream constructor

Returns

-------

plotly.graph_objs.scattermap.Stream

"""

return self["stream"]

@stream.setter

def stream(self, val):

self["stream"] = val

@property

def subplot(self):

"""

Sets a reference between this trace's data coordinates and a

map subplot. If "map" (the default value), the data refer to

`layout.map`. If "map2", the data refer to `layout.map2`, and

so on.

The 'subplot' property is an identifier of a particular

subplot, of type 'map', that may be specified as:

- the string 'map' optionally followed by an integer >= 1

(e.g. 'map', 'map1', 'map2', 'map3', etc.)

Returns

-------

str

"""

return self["subplot"]

@subplot.setter

def subplot(self, val):

self["subplot"] = val

@property

def text(self):

"""

Sets text elements associated with each (lon,lat) pair 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) 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 icon text font (color=map.layer.paint.text-color,

size=map.layer.layout.text-size). Has an effect only when

`type` is set to "symbol".

The 'textfont' property is an instance of Textfont

that may be specified as:

- An instance of :class:`plotly.graph_objs.scattermap.Textfont`

- A dict of string/value properties that will be passed

to the Textfont constructor

Returns

-------

plotly.graph_objs.scattermap.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']

Returns

-------

Any

"""

return self["textposition"]

@textposition.setter

def textposition(self, val):

self["textposition"] = 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

appears 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. Variables that can't be found will be

replaced with the specifier. For example, a template of "data:

%{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1

and y is missing. Variables with an undefined value will be

replaced with the fallback value. All 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` 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 texttemplatefallback(self):

"""

Fallback string that's displayed when a variable referenced in

a template is missing. If the boolean value 'false' is passed

in, the specifier with the missing variable will be displayed.

The 'texttemplatefallback' property accepts values of any type

Returns

-------

Any

"""

return self["texttemplatefallback"]