done
This commit is contained in:
@ -0,0 +1,17 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._bounds import Bounds
|
||||
from ._center import Center
|
||||
from ._domain import Domain
|
||||
from ._layer import Layer
|
||||
from . import layer
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".layer"],
|
||||
["._bounds.Bounds", "._center.Center", "._domain.Domain", "._layer.Layer"],
|
||||
)
|
||||
@ -0,0 +1,160 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Bounds(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map"
|
||||
_path_str = "layout.map.bounds"
|
||||
_valid_props = {"east", "north", "south", "west"}
|
||||
|
||||
@property
|
||||
def east(self):
|
||||
"""
|
||||
Sets the maximum longitude of the map (in degrees East) if
|
||||
`west`, `south` and `north` are declared.
|
||||
|
||||
The 'east' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["east"]
|
||||
|
||||
@east.setter
|
||||
def east(self, val):
|
||||
self["east"] = val
|
||||
|
||||
@property
|
||||
def north(self):
|
||||
"""
|
||||
Sets the maximum latitude of the map (in degrees North) if
|
||||
`east`, `west` and `south` are declared.
|
||||
|
||||
The 'north' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["north"]
|
||||
|
||||
@north.setter
|
||||
def north(self, val):
|
||||
self["north"] = val
|
||||
|
||||
@property
|
||||
def south(self):
|
||||
"""
|
||||
Sets the minimum latitude of the map (in degrees North) if
|
||||
`east`, `west` and `north` are declared.
|
||||
|
||||
The 'south' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["south"]
|
||||
|
||||
@south.setter
|
||||
def south(self, val):
|
||||
self["south"] = val
|
||||
|
||||
@property
|
||||
def west(self):
|
||||
"""
|
||||
Sets the minimum longitude of the map (in degrees East) if
|
||||
`east`, `south` and `north` are declared.
|
||||
|
||||
The 'west' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["west"]
|
||||
|
||||
@west.setter
|
||||
def west(self, val):
|
||||
self["west"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
east
|
||||
Sets the maximum longitude of the map (in degrees East)
|
||||
if `west`, `south` and `north` are declared.
|
||||
north
|
||||
Sets the maximum latitude of the map (in degrees North)
|
||||
if `east`, `west` and `south` are declared.
|
||||
south
|
||||
Sets the minimum latitude of the map (in degrees North)
|
||||
if `east`, `west` and `north` are declared.
|
||||
west
|
||||
Sets the minimum longitude of the map (in degrees East)
|
||||
if `east`, `south` and `north` are declared.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self, arg=None, east=None, north=None, south=None, west=None, **kwargs
|
||||
):
|
||||
"""
|
||||
Construct a new Bounds object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.Bounds`
|
||||
east
|
||||
Sets the maximum longitude of the map (in degrees East)
|
||||
if `west`, `south` and `north` are declared.
|
||||
north
|
||||
Sets the maximum latitude of the map (in degrees North)
|
||||
if `east`, `west` and `south` are declared.
|
||||
south
|
||||
Sets the minimum latitude of the map (in degrees North)
|
||||
if `east`, `west` and `north` are declared.
|
||||
west
|
||||
Sets the minimum longitude of the map (in degrees East)
|
||||
if `east`, `south` and `north` are declared.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Bounds
|
||||
"""
|
||||
super().__init__("bounds")
|
||||
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.layout.map.Bounds
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.Bounds`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("east", arg, east)
|
||||
self._set_property("north", arg, north)
|
||||
self._set_property("south", arg, south)
|
||||
self._set_property("west", arg, west)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,104 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Center(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map"
|
||||
_path_str = "layout.map.center"
|
||||
_valid_props = {"lat", "lon"}
|
||||
|
||||
@property
|
||||
def lat(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["lat"]
|
||||
|
||||
@lat.setter
|
||||
def lat(self, val):
|
||||
self["lat"] = val
|
||||
|
||||
@property
|
||||
def lon(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["lon"]
|
||||
|
||||
@lon.setter
|
||||
def lon(self, val):
|
||||
self["lon"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
lat
|
||||
Sets the latitude of the center of the map (in degrees
|
||||
North).
|
||||
lon
|
||||
Sets the longitude of the center of the map (in degrees
|
||||
East).
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, lat=None, lon=None, **kwargs):
|
||||
"""
|
||||
Construct a new Center object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.Center`
|
||||
lat
|
||||
Sets the latitude of the center of the map (in degrees
|
||||
North).
|
||||
lon
|
||||
Sets the longitude of the center of the map (in degrees
|
||||
East).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Center
|
||||
"""
|
||||
super().__init__("center")
|
||||
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.layout.map.Center
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.Center`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("lat", arg, lat)
|
||||
self._set_property("lon", arg, lon)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,170 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Domain(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map"
|
||||
_path_str = "layout.map.domain"
|
||||
_valid_props = {"column", "row", "x", "y"}
|
||||
|
||||
@property
|
||||
def column(self):
|
||||
"""
|
||||
If there is a layout grid, use the domain for this column in
|
||||
the grid for this map 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
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["column"]
|
||||
|
||||
@column.setter
|
||||
def column(self, val):
|
||||
self["column"] = val
|
||||
|
||||
@property
|
||||
def row(self):
|
||||
"""
|
||||
If there is a layout grid, use the domain for this row in the
|
||||
grid for this map 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
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["row"]
|
||||
|
||||
@row.setter
|
||||
def row(self, val):
|
||||
self["row"] = val
|
||||
|
||||
@property
|
||||
def x(self):
|
||||
"""
|
||||
Sets the horizontal domain of this map subplot (in plot
|
||||
fraction).
|
||||
|
||||
The 'x' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'x[0]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
(1) The 'x[1]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["x"]
|
||||
|
||||
@x.setter
|
||||
def x(self, val):
|
||||
self["x"] = val
|
||||
|
||||
@property
|
||||
def y(self):
|
||||
"""
|
||||
Sets the vertical domain of this map subplot (in plot
|
||||
fraction).
|
||||
|
||||
The 'y' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'y[0]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
(1) The 'y[1]' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["y"]
|
||||
|
||||
@y.setter
|
||||
def y(self, val):
|
||||
self["y"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
column
|
||||
If there is a layout grid, use the domain for this
|
||||
column in the grid for this map subplot .
|
||||
row
|
||||
If there is a layout grid, use the domain for this row
|
||||
in the grid for this map subplot .
|
||||
x
|
||||
Sets the horizontal domain of this map subplot (in plot
|
||||
fraction).
|
||||
y
|
||||
Sets the vertical domain of this map subplot (in plot
|
||||
fraction).
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
|
||||
"""
|
||||
Construct a new Domain object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.Domain`
|
||||
column
|
||||
If there is a layout grid, use the domain for this
|
||||
column in the grid for this map subplot .
|
||||
row
|
||||
If there is a layout grid, use the domain for this row
|
||||
in the grid for this map subplot .
|
||||
x
|
||||
Sets the horizontal domain of this map subplot (in plot
|
||||
fraction).
|
||||
y
|
||||
Sets the vertical domain of this map subplot (in plot
|
||||
fraction).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Domain
|
||||
"""
|
||||
super().__init__("domain")
|
||||
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.layout.map.Domain
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.Domain`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("column", arg, column)
|
||||
self._set_property("row", arg, row)
|
||||
self._set_property("x", arg, x)
|
||||
self._set_property("y", arg, y)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,691 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Layer(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map"
|
||||
_path_str = "layout.map.layer"
|
||||
_valid_props = {
|
||||
"below",
|
||||
"circle",
|
||||
"color",
|
||||
"coordinates",
|
||||
"fill",
|
||||
"line",
|
||||
"maxzoom",
|
||||
"minzoom",
|
||||
"name",
|
||||
"opacity",
|
||||
"source",
|
||||
"sourceattribution",
|
||||
"sourcelayer",
|
||||
"sourcetype",
|
||||
"symbol",
|
||||
"templateitemname",
|
||||
"type",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def below(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["below"]
|
||||
|
||||
@below.setter
|
||||
def below(self, val):
|
||||
self["below"] = val
|
||||
|
||||
@property
|
||||
def circle(self):
|
||||
"""
|
||||
The 'circle' property is an instance of Circle
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.layout.map.layer.Circle`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Circle constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.map.layer.Circle
|
||||
"""
|
||||
return self["circle"]
|
||||
|
||||
@circle.setter
|
||||
def circle(self, val):
|
||||
self["circle"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the primary layer color. If `type` is "circle", color
|
||||
corresponds to the circle color (map.layer.paint.circle-color)
|
||||
If `type` is "line", color corresponds to the line color
|
||||
(map.layer.paint.line-color) If `type` is "fill", color
|
||||
corresponds to the fill color (map.layer.paint.fill-color) If
|
||||
`type` is "symbol", color corresponds to the icon color
|
||||
(map.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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def coordinates(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["coordinates"]
|
||||
|
||||
@coordinates.setter
|
||||
def coordinates(self, val):
|
||||
self["coordinates"] = val
|
||||
|
||||
@property
|
||||
def fill(self):
|
||||
"""
|
||||
The 'fill' property is an instance of Fill
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.layout.map.layer.Fill`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Fill constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.map.layer.Fill
|
||||
"""
|
||||
return self["fill"]
|
||||
|
||||
@fill.setter
|
||||
def fill(self, val):
|
||||
self["fill"] = 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.layout.map.layer.Line`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Line constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.map.layer.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
@property
|
||||
def maxzoom(self):
|
||||
"""
|
||||
Sets the maximum zoom level (map.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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["maxzoom"]
|
||||
|
||||
@maxzoom.setter
|
||||
def maxzoom(self, val):
|
||||
self["maxzoom"] = val
|
||||
|
||||
@property
|
||||
def minzoom(self):
|
||||
"""
|
||||
Sets the minimum zoom level (map.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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["minzoom"]
|
||||
|
||||
@minzoom.setter
|
||||
def minzoom(self, val):
|
||||
self["minzoom"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
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.
|
||||
|
||||
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 layer. If `type` is "circle", opacity
|
||||
corresponds to the circle opacity (map.layer.paint.circle-
|
||||
opacity) If `type` is "line", opacity corresponds to the line
|
||||
opacity (map.layer.paint.line-opacity) If `type` is "fill",
|
||||
opacity corresponds to the fill opacity (map.layer.paint.fill-
|
||||
opacity) If `type` is "symbol", opacity corresponds to the
|
||||
icon/text opacity (map.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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def source(self):
|
||||
"""
|
||||
Sets the source data for this layer (map.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
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["source"]
|
||||
|
||||
@source.setter
|
||||
def source(self, val):
|
||||
self["source"] = val
|
||||
|
||||
@property
|
||||
def sourceattribution(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sourceattribution"]
|
||||
|
||||
@sourceattribution.setter
|
||||
def sourceattribution(self, val):
|
||||
self["sourceattribution"] = val
|
||||
|
||||
@property
|
||||
def sourcelayer(self):
|
||||
"""
|
||||
Specifies the layer to use from a vector tile source
|
||||
(map.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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sourcelayer"]
|
||||
|
||||
@sourcelayer.setter
|
||||
def sourcelayer(self, val):
|
||||
self["sourcelayer"] = val
|
||||
|
||||
@property
|
||||
def sourcetype(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["sourcetype"]
|
||||
|
||||
@sourcetype.setter
|
||||
def sourcetype(self, val):
|
||||
self["sourcetype"] = val
|
||||
|
||||
@property
|
||||
def symbol(self):
|
||||
"""
|
||||
The 'symbol' property is an instance of Symbol
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.layout.map.layer.Symbol`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Symbol constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.map.layer.Symbol
|
||||
"""
|
||||
return self["symbol"]
|
||||
|
||||
@symbol.setter
|
||||
def symbol(self, val):
|
||||
self["symbol"] = val
|
||||
|
||||
@property
|
||||
def templateitemname(self):
|
||||
"""
|
||||
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`.
|
||||
|
||||
The 'templateitemname' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["templateitemname"]
|
||||
|
||||
@templateitemname.setter
|
||||
def templateitemname(self, val):
|
||||
self["templateitemname"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
"""
|
||||
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.
|
||||
|
||||
The 'type' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['circle', 'line', 'fill', 'symbol', 'raster']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["type"]
|
||||
|
||||
@type.setter
|
||||
def type(self, val):
|
||||
self["type"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether this layer is displayed
|
||||
|
||||
The 'visible' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
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.
|
||||
circle
|
||||
:class:`plotly.graph_objects.layout.map.layer.Circle`
|
||||
instance or dict with compatible properties
|
||||
color
|
||||
Sets the primary layer color. If `type` is "circle",
|
||||
color corresponds to the circle color
|
||||
(map.layer.paint.circle-color) If `type` is "line",
|
||||
color corresponds to the line color
|
||||
(map.layer.paint.line-color) If `type` is "fill", color
|
||||
corresponds to the fill color (map.layer.paint.fill-
|
||||
color) If `type` is "symbol", color corresponds to the
|
||||
icon color (map.layer.paint.icon-color)
|
||||
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`.
|
||||
fill
|
||||
:class:`plotly.graph_objects.layout.map.layer.Fill`
|
||||
instance or dict with compatible properties
|
||||
line
|
||||
:class:`plotly.graph_objects.layout.map.layer.Line`
|
||||
instance or dict with compatible properties
|
||||
maxzoom
|
||||
Sets the maximum zoom level (map.layer.maxzoom). At
|
||||
zoom levels equal to or greater than the maxzoom, the
|
||||
layer will be hidden.
|
||||
minzoom
|
||||
Sets the minimum zoom level (map.layer.minzoom). At
|
||||
zoom levels less than the minzoom, the layer will be
|
||||
hidden.
|
||||
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.
|
||||
opacity
|
||||
Sets the opacity of the layer. If `type` is "circle",
|
||||
opacity corresponds to the circle opacity
|
||||
(map.layer.paint.circle-opacity) If `type` is "line",
|
||||
opacity corresponds to the line opacity
|
||||
(map.layer.paint.line-opacity) If `type` is "fill",
|
||||
opacity corresponds to the fill opacity
|
||||
(map.layer.paint.fill-opacity) If `type` is "symbol",
|
||||
opacity corresponds to the icon/text opacity
|
||||
(map.layer.paint.text-opacity)
|
||||
source
|
||||
Sets the source data for this layer (map.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.
|
||||
sourceattribution
|
||||
Sets the attribution for this source.
|
||||
sourcelayer
|
||||
Specifies the layer to use from a vector tile source
|
||||
(map.layer.source-layer). Required for "vector" source
|
||||
type that supports multiple layers.
|
||||
sourcetype
|
||||
Sets the source type for this layer, that is the type
|
||||
of the layer data.
|
||||
symbol
|
||||
:class:`plotly.graph_objects.layout.map.layer.Symbol`
|
||||
instance or dict with compatible properties
|
||||
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`.
|
||||
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.
|
||||
visible
|
||||
Determines whether this layer is displayed
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
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,
|
||||
):
|
||||
"""
|
||||
Construct a new Layer object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.Layer`
|
||||
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.
|
||||
circle
|
||||
:class:`plotly.graph_objects.layout.map.layer.Circle`
|
||||
instance or dict with compatible properties
|
||||
color
|
||||
Sets the primary layer color. If `type` is "circle",
|
||||
color corresponds to the circle color
|
||||
(map.layer.paint.circle-color) If `type` is "line",
|
||||
color corresponds to the line color
|
||||
(map.layer.paint.line-color) If `type` is "fill", color
|
||||
corresponds to the fill color (map.layer.paint.fill-
|
||||
color) If `type` is "symbol", color corresponds to the
|
||||
icon color (map.layer.paint.icon-color)
|
||||
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`.
|
||||
fill
|
||||
:class:`plotly.graph_objects.layout.map.layer.Fill`
|
||||
instance or dict with compatible properties
|
||||
line
|
||||
:class:`plotly.graph_objects.layout.map.layer.Line`
|
||||
instance or dict with compatible properties
|
||||
maxzoom
|
||||
Sets the maximum zoom level (map.layer.maxzoom). At
|
||||
zoom levels equal to or greater than the maxzoom, the
|
||||
layer will be hidden.
|
||||
minzoom
|
||||
Sets the minimum zoom level (map.layer.minzoom). At
|
||||
zoom levels less than the minzoom, the layer will be
|
||||
hidden.
|
||||
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.
|
||||
opacity
|
||||
Sets the opacity of the layer. If `type` is "circle",
|
||||
opacity corresponds to the circle opacity
|
||||
(map.layer.paint.circle-opacity) If `type` is "line",
|
||||
opacity corresponds to the line opacity
|
||||
(map.layer.paint.line-opacity) If `type` is "fill",
|
||||
opacity corresponds to the fill opacity
|
||||
(map.layer.paint.fill-opacity) If `type` is "symbol",
|
||||
opacity corresponds to the icon/text opacity
|
||||
(map.layer.paint.text-opacity)
|
||||
source
|
||||
Sets the source data for this layer (map.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.
|
||||
sourceattribution
|
||||
Sets the attribution for this source.
|
||||
sourcelayer
|
||||
Specifies the layer to use from a vector tile source
|
||||
(map.layer.source-layer). Required for "vector" source
|
||||
type that supports multiple layers.
|
||||
sourcetype
|
||||
Sets the source type for this layer, that is the type
|
||||
of the layer data.
|
||||
symbol
|
||||
:class:`plotly.graph_objects.layout.map.layer.Symbol`
|
||||
instance or dict with compatible properties
|
||||
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`.
|
||||
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.
|
||||
visible
|
||||
Determines whether this layer is displayed
|
||||
|
||||
Returns
|
||||
-------
|
||||
Layer
|
||||
"""
|
||||
super().__init__("layers")
|
||||
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.layout.map.Layer
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.Layer`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("below", arg, below)
|
||||
self._set_property("circle", arg, circle)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("coordinates", arg, coordinates)
|
||||
self._set_property("fill", arg, fill)
|
||||
self._set_property("line", arg, line)
|
||||
self._set_property("maxzoom", arg, maxzoom)
|
||||
self._set_property("minzoom", arg, minzoom)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._set_property("source", arg, source)
|
||||
self._set_property("sourceattribution", arg, sourceattribution)
|
||||
self._set_property("sourcelayer", arg, sourcelayer)
|
||||
self._set_property("sourcetype", arg, sourcetype)
|
||||
self._set_property("symbol", arg, symbol)
|
||||
self._set_property("templateitemname", arg, templateitemname)
|
||||
self._set_property("type", arg, type)
|
||||
self._set_property("visible", arg, visible)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,17 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._circle import Circle
|
||||
from ._fill import Fill
|
||||
from ._line import Line
|
||||
from ._symbol import Symbol
|
||||
from . import symbol
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".symbol"],
|
||||
["._circle.Circle", "._fill.Fill", "._line.Line", "._symbol.Symbol"],
|
||||
)
|
||||
@ -0,0 +1,80 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Circle(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map.layer"
|
||||
_path_str = "layout.map.layer.circle"
|
||||
_valid_props = {"radius"}
|
||||
|
||||
@property
|
||||
def radius(self):
|
||||
"""
|
||||
Sets the circle radius (map.layer.paint.circle-radius). Has an
|
||||
effect only when `type` is set to "circle".
|
||||
|
||||
The 'radius' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["radius"]
|
||||
|
||||
@radius.setter
|
||||
def radius(self, val):
|
||||
self["radius"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
radius
|
||||
Sets the circle radius (map.layer.paint.circle-radius).
|
||||
Has an effect only when `type` is set to "circle".
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, radius=None, **kwargs):
|
||||
"""
|
||||
Construct a new Circle object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.layer.Circle`
|
||||
radius
|
||||
Sets the circle radius (map.layer.paint.circle-radius).
|
||||
Has an effect only when `type` is set to "circle".
|
||||
|
||||
Returns
|
||||
-------
|
||||
Circle
|
||||
"""
|
||||
super().__init__("circle")
|
||||
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.layout.map.layer.Circle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.layer.Circle`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("radius", arg, radius)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,86 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Fill(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map.layer"
|
||||
_path_str = "layout.map.layer.fill"
|
||||
_valid_props = {"outlinecolor"}
|
||||
|
||||
@property
|
||||
def outlinecolor(self):
|
||||
"""
|
||||
Sets the fill outline color (map.layer.paint.fill-outline-
|
||||
color). Has an effect only when `type` is set to "fill".
|
||||
|
||||
The 'outlinecolor' 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["outlinecolor"]
|
||||
|
||||
@outlinecolor.setter
|
||||
def outlinecolor(self, val):
|
||||
self["outlinecolor"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
outlinecolor
|
||||
Sets the fill outline color (map.layer.paint.fill-
|
||||
outline-color). Has an effect only when `type` is set
|
||||
to "fill".
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, outlinecolor=None, **kwargs):
|
||||
"""
|
||||
Construct a new Fill object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.layer.Fill`
|
||||
outlinecolor
|
||||
Sets the fill outline color (map.layer.paint.fill-
|
||||
outline-color). Has an effect only when `type` is set
|
||||
to "fill".
|
||||
|
||||
Returns
|
||||
-------
|
||||
Fill
|
||||
"""
|
||||
super().__init__("fill")
|
||||
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.layout.map.layer.Fill
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.layer.Fill`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("outlinecolor", arg, outlinecolor)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,133 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Line(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map.layer"
|
||||
_path_str = "layout.map.layer.line"
|
||||
_valid_props = {"dash", "dashsrc", "width"}
|
||||
|
||||
@property
|
||||
def dash(self):
|
||||
"""
|
||||
Sets the length of dashes and gaps (map.layer.paint.line-
|
||||
dasharray). Has an effect only when `type` is set to "line".
|
||||
|
||||
The 'dash' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["dash"]
|
||||
|
||||
@dash.setter
|
||||
def dash(self, val):
|
||||
self["dash"] = val
|
||||
|
||||
@property
|
||||
def dashsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `dash`.
|
||||
|
||||
The 'dashsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["dashsrc"]
|
||||
|
||||
@dashsrc.setter
|
||||
def dashsrc(self, val):
|
||||
self["dashsrc"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the line width (map.layer.paint.line-width). Has an effect
|
||||
only when `type` is set to "line".
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
dash
|
||||
Sets the length of dashes and gaps
|
||||
(map.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 (map.layer.paint.line-width). Has
|
||||
an effect only when `type` is set to "line".
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, dash=None, dashsrc=None, width=None, **kwargs):
|
||||
"""
|
||||
Construct a new Line object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.layer.Line`
|
||||
dash
|
||||
Sets the length of dashes and gaps
|
||||
(map.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 (map.layer.paint.line-width). Has
|
||||
an effect only when `type` is set to "line".
|
||||
|
||||
Returns
|
||||
-------
|
||||
Line
|
||||
"""
|
||||
super().__init__("line")
|
||||
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.layout.map.layer.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.layer.Line`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("dash", arg, dash)
|
||||
self._set_property("dashsrc", arg, dashsrc)
|
||||
self._set_property("width", arg, width)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,243 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Symbol(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map.layer"
|
||||
_path_str = "layout.map.layer.symbol"
|
||||
_valid_props = {"icon", "iconsize", "placement", "text", "textfont", "textposition"}
|
||||
|
||||
@property
|
||||
def icon(self):
|
||||
"""
|
||||
Sets the symbol icon image (map.layer.layout.icon-image). Full
|
||||
list: https://www.mapbox.com/maki-icons/
|
||||
|
||||
The 'icon' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["icon"]
|
||||
|
||||
@icon.setter
|
||||
def icon(self, val):
|
||||
self["icon"] = val
|
||||
|
||||
@property
|
||||
def iconsize(self):
|
||||
"""
|
||||
Sets the symbol icon size (map.layer.layout.icon-size). Has an
|
||||
effect only when `type` is set to "symbol".
|
||||
|
||||
The 'iconsize' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["iconsize"]
|
||||
|
||||
@iconsize.setter
|
||||
def iconsize(self, val):
|
||||
self["iconsize"] = val
|
||||
|
||||
@property
|
||||
def placement(self):
|
||||
"""
|
||||
Sets the symbol and/or text placement (map.layer.layout.symbol-
|
||||
placement). If `placement` is "point", the label is placed
|
||||
where the geometry is located If `placement` is "line", the
|
||||
label is placed along the line of the geometry If `placement`
|
||||
is "line-center", the label is placed on the center of the
|
||||
geometry
|
||||
|
||||
The 'placement' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['point', 'line', 'line-center']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["placement"]
|
||||
|
||||
@placement.setter
|
||||
def placement(self, val):
|
||||
self["placement"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the symbol text (map.layer.layout.text-field).
|
||||
|
||||
The 'text' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
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.layout.map.layer.symbol.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.map.layer.symbol.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 _prop_descriptions(self):
|
||||
return """\
|
||||
icon
|
||||
Sets the symbol icon image (map.layer.layout.icon-
|
||||
image). Full list: https://www.mapbox.com/maki-icons/
|
||||
iconsize
|
||||
Sets the symbol icon size (map.layer.layout.icon-size).
|
||||
Has an effect only when `type` is set to "symbol".
|
||||
placement
|
||||
Sets the symbol and/or text placement
|
||||
(map.layer.layout.symbol-placement). If `placement` is
|
||||
"point", the label is placed where the geometry is
|
||||
located If `placement` is "line", the label is placed
|
||||
along the line of the geometry If `placement` is "line-
|
||||
center", the label is placed on the center of the
|
||||
geometry
|
||||
text
|
||||
Sets the symbol text (map.layer.layout.text-field).
|
||||
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.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
icon=None,
|
||||
iconsize=None,
|
||||
placement=None,
|
||||
text=None,
|
||||
textfont=None,
|
||||
textposition=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Symbol object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.layout.map.layer.Symbol`
|
||||
icon
|
||||
Sets the symbol icon image (map.layer.layout.icon-
|
||||
image). Full list: https://www.mapbox.com/maki-icons/
|
||||
iconsize
|
||||
Sets the symbol icon size (map.layer.layout.icon-size).
|
||||
Has an effect only when `type` is set to "symbol".
|
||||
placement
|
||||
Sets the symbol and/or text placement
|
||||
(map.layer.layout.symbol-placement). If `placement` is
|
||||
"point", the label is placed where the geometry is
|
||||
located If `placement` is "line", the label is placed
|
||||
along the line of the geometry If `placement` is "line-
|
||||
center", the label is placed on the center of the
|
||||
geometry
|
||||
text
|
||||
Sets the symbol text (map.layer.layout.text-field).
|
||||
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.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Symbol
|
||||
"""
|
||||
super().__init__("symbol")
|
||||
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.layout.map.layer.Symbol
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.layer.Symbol`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("icon", arg, icon)
|
||||
self._set_property("iconsize", arg, iconsize)
|
||||
self._set_property("placement", arg, placement)
|
||||
self._set_property("text", arg, text)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._set_property("textposition", arg, textposition)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,11 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._textfont import Textfont
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [], ["._textfont.Textfont"]
|
||||
)
|
||||
@ -0,0 +1,202 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Textfont(_BaseLayoutHierarchyType):
|
||||
_parent_path_str = "layout.map.layer.symbol"
|
||||
_path_str = "layout.map.layer.symbol.textfont"
|
||||
_valid_props = {"color", "family", "size", "style", "weight"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
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.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
size=None,
|
||||
style=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
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".
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.lay
|
||||
er.symbol.Textfont`
|
||||
color
|
||||
|
||||
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.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Textfont
|
||||
"""
|
||||
super().__init__("textfont")
|
||||
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.layout.map.layer.symbol.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.map.layer.symbol.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
Reference in New Issue
Block a user