plotly.graph_objects.Scattermap¶

class plotly.graph_objects.Scattermap(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=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, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶
__init__(arg=None, below=None, cluster=None, connectgaps=None, customdata=None, customdatasrc=None, fill=None, fillcolor=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, lon=None, lonsrc=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, selected=None, selectedpoints=None, showlegend=None, stream=None, subplot=None, text=None, textfont=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, uid=None, uirevision=None, unselected=None, visible=None, **kwargs)¶

Construct a new Scattermap object

The data visualized as scatter point, lines or marker symbols on a MapLibre GL geographic map is provided by longitude/latitude pairs in lon and lat.

Parameters

  • arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Scattermap

  • below – 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 “’’”.

  • cluster – plotly.graph_objects.scattermap.Cluster instance or dict with compatible properties

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

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

  • 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 – plotly.graph_objects.scattermap.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 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.

  • 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 – plotly.graph_objects.scattermap.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 – plotly.graph_objects.scattermap.Line instance or dict with compatible properties

  • lon – Sets the longitude coordinates (in degrees East).

  • lonsrc – Sets the source reference on Chart Studio Cloud for lon.

  • marker – plotly.graph_objects.scattermap.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.

  • name – Sets the trace name. The trace name appears as the legend item and on hover.

  • opacity – Sets the opacity of the trace.

  • selected – plotly.graph_objects.scattermap.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 – plotly.graph_objects.scattermap.Stream instance or dict with compatible properties

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

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

  • textfont – 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”.

  • textposition – Sets the positions of the text elements with respects to the (x,y) coordinates.

  • 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 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 – plotly.graph_objects.scattermap.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

Return type

Scattermap

plotly.graph_objects.scattermap¶

plotly.graph_objects.scattermap

class plotly.graph_objects.scattermap.Cluster(arg=None, color=None, colorsrc=None, enabled=None, maxzoom=None, opacity=None, opacitysrc=None, size=None, sizesrc=None, step=None, stepsrc=None, **kwargs)¶
property color¶

Sets the color for each cluster step.

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

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property colorsrc¶

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property enabled¶

Determines whether clustering is enabled or disabled.

The ‘enabled’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property maxzoom¶

Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.

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

  • An int or float in the interval [0, 24]

Returns

Return type

int|float

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 opacitysrc¶

Sets the source reference on Chart Studio Cloud for opacity.

The ‘opacitysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property size¶

Sets the size for each cluster step.

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 sizesrc¶

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property step¶

Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for size and / or color. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

The ‘step’ 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 stepsrc¶

Sets the source reference on Chart Studio Cloud for step.

The ‘stepsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.scattermap.Hoverlabel(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, showarrow=None, **kwargs)¶
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:
  • One of the following enumeration values:

    [‘left’, ‘right’, ‘auto’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property alignsrc¶

Sets the source reference on Chart Studio Cloud for align.

The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bgcolorsrc¶

Sets the source reference on Chart Studio Cloud for bgcolor.

The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolorsrc¶

Sets the source reference on Chart Studio Cloud for bordercolor.

The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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.scattermap.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 a 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 namelengthsrc¶

Sets the source reference on Chart Studio Cloud for namelength.

The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property showarrow¶

Sets whether or not to show the hover label arrow/triangle pointing to the data point.

The ‘showarrow’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

class plotly.graph_objects.scattermap.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶
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.scattermap.legendgrouptitle.Font

property text¶

Sets the title of the legend group.

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

  • A string

  • A number that will be converted to a string

Returns

Return type

str

class plotly.graph_objects.scattermap.Line(arg=None, color=None, width=None, **kwargs)¶
property color¶

Sets the line color.

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

Return type

str

property width¶

Sets the line width (in px).

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

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

Returns

Return type

int|float

class plotly.graph_objects.scattermap.Marker(arg=None, allowoverlap=None, angle=None, anglesrc=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, colorsrc=None, opacity=None, opacitysrc=None, reversescale=None, showscale=None, size=None, sizemin=None, sizemode=None, sizeref=None, sizesrc=None, symbol=None, symbolsrc=None, **kwargs)¶
property allowoverlap¶

Flag to draw all symbols, even if they overlap.

The ‘allowoverlap’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property angle¶

Sets the marker orientation from true North, in degrees clockwise. When using the “auto” default, no rotation would be applied in perspective views which is different from using a zero angle.

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

  • An int or float

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property anglesrc¶

Sets the source reference on Chart Studio Cloud for angle.

The ‘anglesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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 must be specified as a bool (either True, or False)

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 must be specified as a bool (either True, or False)

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:

  • An int or float

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:

  • An int or float

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:

  • An int or float

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

  • A number that will be interpreted as a color according to scattermap.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.scattermap.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, hsv, 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 colorsrc¶

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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 opacitysrc¶

Sets the source reference on Chart Studio Cloud for opacity.

The ‘opacitysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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 must be specified as a bool (either True, or False)

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 must be specified as a bool (either True, or False)

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:

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

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:

  • An int or float

Returns

Return type

int|float

property sizesrc¶

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property symbol¶

//www.mapbox.com/maki- icons/ Note that the array marker.color and marker.size are only available for “circle” symbols.

The ‘symbol’ 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

Type

Sets the marker symbol. Full list

Type

https

property symbolsrc¶

Sets the source reference on Chart Studio Cloud for symbol.

The ‘symbolsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.scattermap.Selected(arg=None, marker=None, **kwargs)¶
property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.scattermap.selected.Marker

class plotly.graph_objects.scattermap.Stream(arg=None, maxpoints=None, token=None, **kwargs)¶
property maxpoints¶

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

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

  • An int or float in the interval [0, 10000]

Returns

Return type

int|float

property token¶

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

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

  • A non-empty string

Returns

Return type

str

class plotly.graph_objects.scattermap.Textfont(arg=None, color=None, family=None, size=None, style=None, weight=None, **kwargs)¶
property color¶
The ‘color’ 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

Return type

str

property family¶

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

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

  • A non-empty string

Returns

Return type

str

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

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

Returns

Return type

int|float

property style¶

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

The ‘style’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘normal’, ‘italic’]

Returns

Return type

Any

property weight¶

Sets the weight (or boldness) of the font.

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

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

Returns

Return type

int

class plotly.graph_objects.scattermap.Unselected(arg=None, marker=None, **kwargs)¶
property marker¶

The ‘marker’ property is an instance of Marker that may be specified as:

Returns

Return type

plotly.graph_objects.scattermap.unselected.Marker