plotly.graph_objects.layout.mapbox.
Bounds
(arg=None, east=None, north=None, south=None, west=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
east
¶Sets the maximum longitude of the map (in degrees East) if
west
, south
and north
are declared.
An int or float
int|float
north
¶Sets the maximum latitude of the map (in degrees North) if
east
, west
and south
are declared.
An int or float
int|float
south
¶Sets the minimum latitude of the map (in degrees North) if
east
, west
and north
are declared.
An int or float
int|float
west
¶Sets the minimum longitude of the map (in degrees East) if
east
, south
and north
are declared.
An int or float
int|float
plotly.graph_objects.layout.mapbox.
Center
(arg=None, lat=None, lon=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
lat
¶Sets the latitude of the center of the map (in degrees North).
An int or float
int|float
lon
¶Sets the longitude of the center of the map (in degrees East).
An int or float
int|float
plotly.graph_objects.layout.mapbox.
Domain
(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
column
¶If there is a layout grid, use the domain for this column in the grid for this mapbox subplot .
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
row
¶If there is a layout grid, use the domain for this row in the grid for this mapbox subplot .
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
x
¶fraction).
The ‘x’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
An int or float in the interval [0, 1]
An int or float in the interval [0, 1]
list
y
¶fraction).
The ‘y’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
An int or float in the interval [0, 1]
An int or float in the interval [0, 1]
list
plotly.graph_objects.layout.mapbox.
Layer
(arg=None, below=None, circle=None, color=None, coordinates=None, fill=None, line=None, maxzoom=None, minzoom=None, name=None, opacity=None, source=None, sourceattribution=None, sourcelayer=None, sourcetype=None, symbol=None, templateitemname=None, type=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseLayoutHierarchyType
below
¶Determines if the layer will be inserted before the layer with the specified ID. If omitted or set to ‘’, the layer will be inserted above every existing layer.
A string
A number that will be converted to a string
circle
¶The ‘circle’ property is an instance of Circle that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.layer.Circle
A dict of string/value properties that will be passed to the Circle constructor
Supported dict properties:
- radius
Sets the circle radius (mapbox.layer.paint.circle-radius). Has an effect only when
type
is set to “circle”.
color
¶Sets the primary layer color. If type
is “circle”, color
corresponds to the circle color (mapbox.layer.paint.circle-
color) If type
is “line”, color corresponds to the line color
(mapbox.layer.paint.line-color) If type
is “fill”, color
corresponds to the fill color (mapbox.layer.paint.fill-color)
If type
is “symbol”, color corresponds to the icon color
(mapbox.layer.paint.icon-color)
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
coordinates
¶Sets the coordinates array contains [longitude, latitude] pairs
for the image corners listed in clockwise order: top left, top
right, bottom right, bottom left. Only has an effect for
“image” sourcetype
.
The ‘coordinates’ property accepts values of any type
Any
fill
¶The ‘fill’ property is an instance of Fill that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.layer.Fill
A dict of string/value properties that will be passed to the Fill constructor
Supported dict properties:
- outlinecolor
Sets the fill outline color (mapbox.layer.paint.fill-outline-color). Has an effect only when
type
is set to “fill”.
line
¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.layer.Line
A dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- dash
Sets the length of dashes and gaps (mapbox.layer.paint.line-dasharray). Has an effect only when
type
is set to “line”.- dashsrc
Sets the source reference on Chart Studio Cloud for
dash
.- width
Sets the line width (mapbox.layer.paint.line- width). Has an effect only when
type
is set to “line”.
maxzoom
¶Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
An int or float in the interval [0, 24]
int|float
minzoom
¶Sets the minimum zoom level (mapbox.layer.minzoom). At zoom levels less than the minzoom, the layer will be hidden.
An int or float in the interval [0, 24]
int|float
name
¶When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with templateitemname
matching this
name
alongside your modifications (including visible: false
or enabled: false
to hide it). Has no effect outside of a
template.
A string
A number that will be converted to a string
opacity
¶Sets the opacity of the layer. If type
is “circle”, opacity
corresponds to the circle opacity (mapbox.layer.paint.circle-
opacity) If type
is “line”, opacity corresponds to the line
opacity (mapbox.layer.paint.line-opacity) If type
is “fill”,
opacity corresponds to the fill opacity
(mapbox.layer.paint.fill-opacity) If type
is “symbol”,
opacity corresponds to the icon/text opacity
(mapbox.layer.paint.text-opacity)
An int or float in the interval [0, 1]
int|float
source
¶Sets the source data for this layer (mapbox.layer.source). When
sourcetype
is set to “geojson”, source
can be a URL to a
GeoJSON or a GeoJSON object. When sourcetype
is set to
“vector” or “raster”, source
can be a URL or an array of tile
URLs. When sourcetype
is set to “image”, source
can be a
URL to an image.
The ‘source’ property accepts values of any type
Any
sourceattribution
¶Sets the attribution for this source.
A string
A number that will be converted to a string
sourcelayer
¶Specifies the layer to use from a vector tile source (mapbox.layer.source-layer). Required for “vector” source type that supports multiple layers.
A string
A number that will be converted to a string
sourcetype
¶Sets the source type for this layer, that is the type of the layer data.
[‘geojson’, ‘vector’, ‘raster’, ‘image’]
Any
symbol
¶The ‘symbol’ property is an instance of Symbol that may be specified as:
An instance of
plotly.graph_objects.layout.mapbox.layer.Symbol
A dict of string/value properties that will be passed to the Symbol constructor
Supported dict properties:
- icon
Sets the symbol icon image (mapbox.layer.layout.icon-image). Full list: https://www.mapbox.com/maki-icons/
- iconsize
Sets the symbol icon size (mapbox.layer.layout.icon-size). Has an effect only when
type
is set to “symbol”.- placement
Sets the symbol and/or text placement (mapbox.layer.layout.symbol-placement). If
placement
is “point”, the label is placed where the geometry is located Ifplacement
is “line”, the label is placed along the line of the geometry Ifplacement
is “line-center”, the label is placed on the center of the geometry- text
Sets the symbol text (mapbox.layer.layout.text- field).
- textfont
Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.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.
templateitemname
¶Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with templateitemname
matching its name
,
alongside your modifications (including visible: false
or
enabled: false
to hide it). If there is no template or no
matching item, this item will be hidden unless you explicitly
show it with visible: true
.
A string
A number that will be converted to a string
type
¶Sets the layer type, that is the how the layer data set in
source
will be rendered With sourcetype
set to “geojson”,
the following values are allowed: “circle”, “line”, “fill” and
“symbol”. but note that “line” and “fill” are not compatible
with Point GeoJSON geometries. With sourcetype
set to
“vector”, the following values are allowed: “circle”, “line”,
“fill” and “symbol”. With sourcetype
set to “raster” or
*image*
, only the “raster” value is allowed.
[‘circle’, ‘line’, ‘fill’, ‘symbol’, ‘raster’]
Any