plotly.graph_objects.layout.mapbox package¶
-
class
plotly.graph_objects.layout.mapbox.
Bounds
(arg=None, east=None, north=None, south=None, west=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
east
¶ Sets the maximum longitude of the map (in degrees East) if
west
,south
andnorth
are declared.- The ‘east’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
north
¶ Sets the maximum latitude of the map (in degrees North) if
east
,west
andsouth
are declared.- The ‘north’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
south
¶ Sets the minimum latitude of the map (in degrees North) if
east
,west
andnorth
are declared.- The ‘south’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
west
¶ Sets the minimum longitude of the map (in degrees East) if
east
,south
andnorth
are declared.- The ‘west’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
-
class
plotly.graph_objects.layout.mapbox.
Center
(arg=None, lat=None, lon=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
lat
¶ Sets the latitude of the center of the map (in degrees North).
- The ‘lat’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
lon
¶ Sets the longitude of the center of the map (in degrees East).
- The ‘lon’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
-
class
plotly.graph_objects.layout.mapbox.
Domain
(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶ Bases:
plotly.basedatatypes.BaseLayoutHierarchyType
-
property
column
¶ If there is a layout grid, use the domain for this column in the grid for this mapbox subplot .
- The ‘column’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
- Returns
- Return type
-
property
row
¶ If there is a layout grid, use the domain for this row in the grid for this mapbox subplot .
- The ‘row’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
- Returns
- Return type
-
property
x
¶ - Sets the horizontal domain of this mapbox subplot (in plot
fraction).
The ‘x’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
- The ‘x[0]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
- The ‘x[1]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
list
-
property
y
¶ - Sets the vertical domain of this mapbox subplot (in plot
fraction).
The ‘y’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
- The ‘y[0]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
- The ‘y[1]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
list
-
property
-
class
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
-
property
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.
- The ‘below’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
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
- Returns
- Return type
-
property
color
¶ Sets the primary layer color. If
type
is “circle”, color corresponds to the circle color (mapbox.layer.paint.circle- color) Iftype
is “line”, color corresponds to the line color (mapbox.layer.paint.line-color) Iftype
is “fill”, color corresponds to the fill color (mapbox.layer.paint.fill-color) Iftype
is “symbol”, color corresponds to the icon color (mapbox.layer.paint.icon-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
-
property
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
- Returns
- Return type
Any
-
property
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
- Returns
- Return type
-
property
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
- Returns
- Return type
-
property
maxzoom
¶ Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
- 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
minzoom
¶ Sets the minimum zoom level (mapbox.layer.minzoom). At zoom levels less than the minzoom, the layer will be hidden.
- The ‘minzoom’ property is a number and may be specified as:
An int or float in the interval [0, 24]
- Returns
- Return type
int|float
-
property
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 thisname
alongside your modifications (includingvisible: false
orenabled: false
to hide it). Has no effect outside of a template.- The ‘name’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
opacity
¶ Sets the opacity of the layer. If
type
is “circle”, opacity corresponds to the circle opacity (mapbox.layer.paint.circle- opacity) Iftype
is “line”, opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity) Iftype
is “fill”, opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity) Iftype
is “symbol”, opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity)- The ‘opacity’ property is a number and may be specified as:
An int or float in the interval [0, 1]
- Returns
- Return type
int|float
-
property
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. Whensourcetype
is set to “vector” or “raster”,source
can be a URL or an array of tile URLs. Whensourcetype
is set to “image”,source
can be a URL to an image.The ‘source’ property accepts values of any type
- Returns
- Return type
Any
-
property
sourceattribution
¶ Sets the attribution for this source.
- The ‘sourceattribution’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
sourcelayer
¶ Specifies the layer to use from a vector tile source (mapbox.layer.source-layer). Required for “vector” source type that supports multiple layers.
- The ‘sourcelayer’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
sourcetype
¶ Sets the source type for this layer, that is the type of the layer data.
- The ‘sourcetype’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘geojson’, ‘vector’, ‘raster’, ‘image’]
- Returns
- Return type
Any
-
property
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
- Returns
- Return type
-
property
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 itsname
, alongside your modifications (includingvisible: false
orenabled: false
to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true
.- The ‘templateitemname’ property is a string and must be specified as:
A string
A number that will be converted to a string
- Returns
- Return type
-
property
type
¶ Sets the layer type, that is the how the layer data set in
source
will be rendered Withsourcetype
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. Withsourcetype
set to “vector”, the following values are allowed: “circle”, “line”, “fill” and “symbol”. Withsourcetype
set to “raster” or*image*
, only the “raster” value is allowed.- The ‘type’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘circle’, ‘line’, ‘fill’, ‘symbol’, ‘raster’]
- Returns
- Return type
Any
-
property