mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-07-01 22:13:01 +00:00
first commit
This commit is contained in:
Ayxan
@ -0,0 +1,14 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or TYPE_CHECKING:
|
||||
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"], ["._center.Center", "._domain.Domain", "._layer.Layer"]
|
||||
)
|
||||
@ -0,0 +1,131 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Center(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox"
|
||||
_path_str = "layout.mapbox.center"
|
||||
_valid_props = {"lat", "lon"}
|
||||
|
||||
# lat
|
||||
# ---
|
||||
@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
|
||||
|
||||
# lon
|
||||
# ---
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@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.mapbox.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(Center, self).__init__("center")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.Center
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.Center`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("lat", None)
|
||||
_v = lat if lat is not None else _v
|
||||
if _v is not None:
|
||||
self["lat"] = _v
|
||||
_v = arg.pop("lon", None)
|
||||
_v = lon if lon is not None else _v
|
||||
if _v is not None:
|
||||
self["lon"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,207 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Domain(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox"
|
||||
_path_str = "layout.mapbox.domain"
|
||||
_valid_props = {"column", "row", "x", "y"}
|
||||
|
||||
# column
|
||||
# ------
|
||||
@property
|
||||
def column(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["column"]
|
||||
|
||||
@column.setter
|
||||
def column(self, val):
|
||||
self["column"] = val
|
||||
|
||||
# row
|
||||
# ---
|
||||
@property
|
||||
def row(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["row"]
|
||||
|
||||
@row.setter
|
||||
def row(self, val):
|
||||
self["row"] = val
|
||||
|
||||
# x
|
||||
# -
|
||||
@property
|
||||
def x(self):
|
||||
"""
|
||||
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:
|
||||
(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
|
||||
|
||||
# y
|
||||
# -
|
||||
@property
|
||||
def y(self):
|
||||
"""
|
||||
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:
|
||||
(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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
column
|
||||
If there is a layout grid, use the domain for this
|
||||
column in the grid for this mapbox subplot .
|
||||
row
|
||||
If there is a layout grid, use the domain for this row
|
||||
in the grid for this mapbox subplot .
|
||||
x
|
||||
Sets the horizontal domain of this mapbox subplot (in
|
||||
plot fraction).
|
||||
y
|
||||
Sets the vertical domain of this mapbox 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.mapbox.Domain`
|
||||
column
|
||||
If there is a layout grid, use the domain for this
|
||||
column in the grid for this mapbox subplot .
|
||||
row
|
||||
If there is a layout grid, use the domain for this row
|
||||
in the grid for this mapbox subplot .
|
||||
x
|
||||
Sets the horizontal domain of this mapbox subplot (in
|
||||
plot fraction).
|
||||
y
|
||||
Sets the vertical domain of this mapbox subplot (in
|
||||
plot fraction).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Domain
|
||||
"""
|
||||
super(Domain, self).__init__("domain")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.Domain
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.Domain`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("column", None)
|
||||
_v = column if column is not None else _v
|
||||
if _v is not None:
|
||||
self["column"] = _v
|
||||
_v = arg.pop("row", None)
|
||||
_v = row if row is not None else _v
|
||||
if _v is not None:
|
||||
self["row"] = _v
|
||||
_v = arg.pop("x", None)
|
||||
_v = x if x is not None else _v
|
||||
if _v is not None:
|
||||
self["x"] = _v
|
||||
_v = arg.pop("y", None)
|
||||
_v = y if y is not None else _v
|
||||
if _v is not None:
|
||||
self["y"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,896 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Layer(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox"
|
||||
_path_str = "layout.mapbox.layer"
|
||||
_valid_props = {
|
||||
"below",
|
||||
"circle",
|
||||
"color",
|
||||
"coordinates",
|
||||
"fill",
|
||||
"line",
|
||||
"maxzoom",
|
||||
"minzoom",
|
||||
"name",
|
||||
"opacity",
|
||||
"source",
|
||||
"sourceattribution",
|
||||
"sourcelayer",
|
||||
"sourcetype",
|
||||
"symbol",
|
||||
"templateitemname",
|
||||
"type",
|
||||
"visible",
|
||||
}
|
||||
|
||||
# below
|
||||
# -----
|
||||
@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
|
||||
|
||||
# circle
|
||||
# ------
|
||||
@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.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".
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.mapbox.layer.Circle
|
||||
"""
|
||||
return self["circle"]
|
||||
|
||||
@circle.setter
|
||||
def circle(self, val):
|
||||
self["circle"] = val
|
||||
|
||||
# color
|
||||
# -----
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
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)
|
||||
|
||||
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:
|
||||
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
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
# coordinates
|
||||
# -----------
|
||||
@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
|
||||
|
||||
# fill
|
||||
# ----
|
||||
@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.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".
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.mapbox.layer.Fill
|
||||
"""
|
||||
return self["fill"]
|
||||
|
||||
@fill.setter
|
||||
def fill(self, val):
|
||||
self["fill"] = val
|
||||
|
||||
# line
|
||||
# ----
|
||||
@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.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".
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.mapbox.layer.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
# maxzoom
|
||||
# -------
|
||||
@property
|
||||
def maxzoom(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["maxzoom"]
|
||||
|
||||
@maxzoom.setter
|
||||
def maxzoom(self, val):
|
||||
self["maxzoom"] = val
|
||||
|
||||
# minzoom
|
||||
# -------
|
||||
@property
|
||||
def minzoom(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["minzoom"]
|
||||
|
||||
@minzoom.setter
|
||||
def minzoom(self, val):
|
||||
self["minzoom"] = val
|
||||
|
||||
# name
|
||||
# ----
|
||||
@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
|
||||
|
||||
# opacity
|
||||
# -------
|
||||
@property
|
||||
def opacity(self):
|
||||
"""
|
||||
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)
|
||||
|
||||
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
|
||||
|
||||
# source
|
||||
# ------
|
||||
@property
|
||||
def source(self):
|
||||
"""
|
||||
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
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["source"]
|
||||
|
||||
@source.setter
|
||||
def source(self, val):
|
||||
self["source"] = val
|
||||
|
||||
# sourceattribution
|
||||
# -----------------
|
||||
@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
|
||||
|
||||
# sourcelayer
|
||||
# -----------
|
||||
@property
|
||||
def sourcelayer(self):
|
||||
"""
|
||||
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
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sourcelayer"]
|
||||
|
||||
@sourcelayer.setter
|
||||
def sourcelayer(self, val):
|
||||
self["sourcelayer"] = val
|
||||
|
||||
# sourcetype
|
||||
# ----------
|
||||
@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
|
||||
|
||||
# symbol
|
||||
# ------
|
||||
@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.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 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 (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.
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.mapbox.layer.Symbol
|
||||
"""
|
||||
return self["symbol"]
|
||||
|
||||
@symbol.setter
|
||||
def symbol(self, val):
|
||||
self["symbol"] = val
|
||||
|
||||
# templateitemname
|
||||
# ----------------
|
||||
@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
|
||||
|
||||
# type
|
||||
# ----
|
||||
@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
|
||||
|
||||
# visible
|
||||
# -------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@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.mapbox.layer.Circle
|
||||
` instance or dict with compatible properties
|
||||
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)
|
||||
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.mapbox.layer.Fill`
|
||||
instance or dict with compatible properties
|
||||
line
|
||||
:class:`plotly.graph_objects.layout.mapbox.layer.Line`
|
||||
instance or dict with compatible properties
|
||||
maxzoom
|
||||
Sets the maximum zoom level (mapbox.layer.maxzoom). At
|
||||
zoom levels equal to or greater than the maxzoom, the
|
||||
layer will be hidden.
|
||||
minzoom
|
||||
Sets the minimum zoom level (mapbox.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
|
||||
(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)
|
||||
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.
|
||||
sourceattribution
|
||||
Sets the attribution for this source.
|
||||
sourcelayer
|
||||
Specifies the layer to use from a vector tile source
|
||||
(mapbox.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.mapbox.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.mapbox.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.mapbox.layer.Circle
|
||||
` instance or dict with compatible properties
|
||||
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)
|
||||
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.mapbox.layer.Fill`
|
||||
instance or dict with compatible properties
|
||||
line
|
||||
:class:`plotly.graph_objects.layout.mapbox.layer.Line`
|
||||
instance or dict with compatible properties
|
||||
maxzoom
|
||||
Sets the maximum zoom level (mapbox.layer.maxzoom). At
|
||||
zoom levels equal to or greater than the maxzoom, the
|
||||
layer will be hidden.
|
||||
minzoom
|
||||
Sets the minimum zoom level (mapbox.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
|
||||
(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)
|
||||
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.
|
||||
sourceattribution
|
||||
Sets the attribution for this source.
|
||||
sourcelayer
|
||||
Specifies the layer to use from a vector tile source
|
||||
(mapbox.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.mapbox.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(Layer, self).__init__("layers")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.Layer
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.Layer`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("below", None)
|
||||
_v = below if below is not None else _v
|
||||
if _v is not None:
|
||||
self["below"] = _v
|
||||
_v = arg.pop("circle", None)
|
||||
_v = circle if circle is not None else _v
|
||||
if _v is not None:
|
||||
self["circle"] = _v
|
||||
_v = arg.pop("color", None)
|
||||
_v = color if color is not None else _v
|
||||
if _v is not None:
|
||||
self["color"] = _v
|
||||
_v = arg.pop("coordinates", None)
|
||||
_v = coordinates if coordinates is not None else _v
|
||||
if _v is not None:
|
||||
self["coordinates"] = _v
|
||||
_v = arg.pop("fill", None)
|
||||
_v = fill if fill is not None else _v
|
||||
if _v is not None:
|
||||
self["fill"] = _v
|
||||
_v = arg.pop("line", None)
|
||||
_v = line if line is not None else _v
|
||||
if _v is not None:
|
||||
self["line"] = _v
|
||||
_v = arg.pop("maxzoom", None)
|
||||
_v = maxzoom if maxzoom is not None else _v
|
||||
if _v is not None:
|
||||
self["maxzoom"] = _v
|
||||
_v = arg.pop("minzoom", None)
|
||||
_v = minzoom if minzoom is not None else _v
|
||||
if _v is not None:
|
||||
self["minzoom"] = _v
|
||||
_v = arg.pop("name", None)
|
||||
_v = name if name is not None else _v
|
||||
if _v is not None:
|
||||
self["name"] = _v
|
||||
_v = arg.pop("opacity", None)
|
||||
_v = opacity if opacity is not None else _v
|
||||
if _v is not None:
|
||||
self["opacity"] = _v
|
||||
_v = arg.pop("source", None)
|
||||
_v = source if source is not None else _v
|
||||
if _v is not None:
|
||||
self["source"] = _v
|
||||
_v = arg.pop("sourceattribution", None)
|
||||
_v = sourceattribution if sourceattribution is not None else _v
|
||||
if _v is not None:
|
||||
self["sourceattribution"] = _v
|
||||
_v = arg.pop("sourcelayer", None)
|
||||
_v = sourcelayer if sourcelayer is not None else _v
|
||||
if _v is not None:
|
||||
self["sourcelayer"] = _v
|
||||
_v = arg.pop("sourcetype", None)
|
||||
_v = sourcetype if sourcetype is not None else _v
|
||||
if _v is not None:
|
||||
self["sourcetype"] = _v
|
||||
_v = arg.pop("symbol", None)
|
||||
_v = symbol if symbol is not None else _v
|
||||
if _v is not None:
|
||||
self["symbol"] = _v
|
||||
_v = arg.pop("templateitemname", None)
|
||||
_v = templateitemname if templateitemname is not None else _v
|
||||
if _v is not None:
|
||||
self["templateitemname"] = _v
|
||||
_v = arg.pop("type", None)
|
||||
_v = type if type is not None else _v
|
||||
if _v is not None:
|
||||
self["type"] = _v
|
||||
_v = arg.pop("visible", None)
|
||||
_v = visible if visible is not None else _v
|
||||
if _v is not None:
|
||||
self["visible"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,17 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or 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,104 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Circle(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox.layer"
|
||||
_path_str = "layout.mapbox.layer.circle"
|
||||
_valid_props = {"radius"}
|
||||
|
||||
# radius
|
||||
# ------
|
||||
@property
|
||||
def radius(self):
|
||||
"""
|
||||
Sets the circle radius (mapbox.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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
radius
|
||||
Sets the circle radius (mapbox.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.mapbox.layer.Circle`
|
||||
radius
|
||||
Sets the circle radius (mapbox.layer.paint.circle-
|
||||
radius). Has an effect only when `type` is set to
|
||||
"circle".
|
||||
|
||||
Returns
|
||||
-------
|
||||
Circle
|
||||
"""
|
||||
super(Circle, self).__init__("circle")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.layer.Circle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Circle`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("radius", None)
|
||||
_v = radius if radius is not None else _v
|
||||
if _v is not None:
|
||||
self["radius"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,143 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Fill(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox.layer"
|
||||
_path_str = "layout.mapbox.layer.fill"
|
||||
_valid_props = {"outlinecolor"}
|
||||
|
||||
# outlinecolor
|
||||
# ------------
|
||||
@property
|
||||
def outlinecolor(self):
|
||||
"""
|
||||
Sets the fill outline color (mapbox.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:
|
||||
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
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["outlinecolor"]
|
||||
|
||||
@outlinecolor.setter
|
||||
def outlinecolor(self, val):
|
||||
self["outlinecolor"] = val
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
outlinecolor
|
||||
Sets the fill outline color (mapbox.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.mapbox.layer.Fill`
|
||||
outlinecolor
|
||||
Sets the fill outline color (mapbox.layer.paint.fill-
|
||||
outline-color). Has an effect only when `type` is set
|
||||
to "fill".
|
||||
|
||||
Returns
|
||||
-------
|
||||
Fill
|
||||
"""
|
||||
super(Fill, self).__init__("fill")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.layer.Fill
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Fill`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("outlinecolor", None)
|
||||
_v = outlinecolor if outlinecolor is not None else _v
|
||||
if _v is not None:
|
||||
self["outlinecolor"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,165 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Line(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox.layer"
|
||||
_path_str = "layout.mapbox.layer.line"
|
||||
_valid_props = {"dash", "dashsrc", "width"}
|
||||
|
||||
# dash
|
||||
# ----
|
||||
@property
|
||||
def dash(self):
|
||||
"""
|
||||
Sets the length of dashes and gaps (mapbox.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
|
||||
|
||||
# dashsrc
|
||||
# -------
|
||||
@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
|
||||
|
||||
# width
|
||||
# -----
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the line width (mapbox.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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
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".
|
||||
"""
|
||||
|
||||
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.mapbox.layer.Line`
|
||||
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".
|
||||
|
||||
Returns
|
||||
-------
|
||||
Line
|
||||
"""
|
||||
super(Line, self).__init__("line")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.layer.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Line`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("dash", None)
|
||||
_v = dash if dash is not None else _v
|
||||
if _v is not None:
|
||||
self["dash"] = _v
|
||||
_v = arg.pop("dashsrc", None)
|
||||
_v = dashsrc if dashsrc is not None else _v
|
||||
if _v is not None:
|
||||
self["dashsrc"] = _v
|
||||
_v = arg.pop("width", None)
|
||||
_v = width if width is not None else _v
|
||||
if _v is not None:
|
||||
self["width"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,315 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Symbol(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox.layer"
|
||||
_path_str = "layout.mapbox.layer.symbol"
|
||||
_valid_props = {"icon", "iconsize", "placement", "text", "textfont", "textposition"}
|
||||
|
||||
# icon
|
||||
# ----
|
||||
@property
|
||||
def icon(self):
|
||||
"""
|
||||
Sets the symbol icon image (mapbox.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
|
||||
|
||||
# iconsize
|
||||
# --------
|
||||
@property
|
||||
def iconsize(self):
|
||||
"""
|
||||
Sets the symbol icon size (mapbox.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
|
||||
|
||||
# placement
|
||||
# ---------
|
||||
@property
|
||||
def placement(self):
|
||||
"""
|
||||
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 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
|
||||
|
||||
# text
|
||||
# ----
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the symbol text (mapbox.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
|
||||
|
||||
# textfont
|
||||
# --------
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
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".
|
||||
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.layout.mapbox.layer.symbol.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Supported dict properties:
|
||||
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be
|
||||
applied by the web browser. The web browser
|
||||
will only be able to apply a font if it is
|
||||
available on the system which it operates.
|
||||
Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to
|
||||
apply fonts if they aren't available on the
|
||||
system. The Chart Studio Cloud (at
|
||||
https://chart-studio.plotly.com or on-premise)
|
||||
generates images on a server, where only a
|
||||
select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto",
|
||||
"Courier New", "Droid Sans",, "Droid Serif",
|
||||
"Droid Sans Mono", "Gravitas One", "Old
|
||||
Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.layout.mapbox.layer.symbol.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
# textposition
|
||||
# ------------
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
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 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 (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.
|
||||
"""
|
||||
|
||||
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.mapbox.layer.Symbol`
|
||||
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 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 (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.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Symbol
|
||||
"""
|
||||
super(Symbol, self).__init__("symbol")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.layer.Symbol
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Symbol`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("icon", None)
|
||||
_v = icon if icon is not None else _v
|
||||
if _v is not None:
|
||||
self["icon"] = _v
|
||||
_v = arg.pop("iconsize", None)
|
||||
_v = iconsize if iconsize is not None else _v
|
||||
if _v is not None:
|
||||
self["iconsize"] = _v
|
||||
_v = arg.pop("placement", None)
|
||||
_v = placement if placement is not None else _v
|
||||
if _v is not None:
|
||||
self["placement"] = _v
|
||||
_v = arg.pop("text", None)
|
||||
_v = text if text is not None else _v
|
||||
if _v is not None:
|
||||
self["text"] = _v
|
||||
_v = arg.pop("textfont", None)
|
||||
_v = textfont if textfont is not None else _v
|
||||
if _v is not None:
|
||||
self["textfont"] = _v
|
||||
_v = arg.pop("textposition", None)
|
||||
_v = textposition if textposition is not None else _v
|
||||
if _v is not None:
|
||||
self["textposition"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,11 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if sys.version_info < (3, 7) or 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,229 @@
|
||||
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Textfont(_BaseLayoutHierarchyType):
|
||||
|
||||
# class properties
|
||||
# --------------------
|
||||
_parent_path_str = "layout.mapbox.layer.symbol"
|
||||
_path_str = "layout.mapbox.layer.symbol.textfont"
|
||||
_valid_props = {"color", "family", "size"}
|
||||
|
||||
# color
|
||||
# -----
|
||||
@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:
|
||||
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
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
# family
|
||||
# ------
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser will only be able to apply a font if
|
||||
it is available on the system which it operates. Provide
|
||||
multiple font families, separated by commas, to indicate the
|
||||
preference in which to apply fonts if they aren't available on
|
||||
the system. The Chart Studio Cloud (at https://chart-
|
||||
studio.plotly.com or on-premise) generates images on a server,
|
||||
where only a select number of fonts are installed and
|
||||
supported. These include "Arial", "Balto", "Courier New",
|
||||
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
|
||||
Narrow", "Raleway", "Times New Roman".
|
||||
|
||||
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
|
||||
|
||||
# size
|
||||
# ----
|
||||
@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
|
||||
|
||||
# Self properties description
|
||||
# ---------------------------
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
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".
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.
|
||||
layer.symbol.Textfont`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser will only be able to
|
||||
apply a font if it is available on the system which it
|
||||
operates. Provide multiple font families, separated by
|
||||
commas, to indicate the preference in which to apply
|
||||
fonts if they aren't available on the system. The Chart
|
||||
Studio Cloud (at https://chart-studio.plotly.com or on-
|
||||
premise) generates images on a server, where only a
|
||||
select number of fonts are installed and supported.
|
||||
These include "Arial", "Balto", "Courier New", "Droid
|
||||
Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
|
||||
One", "Old Standard TT", "Open Sans", "Overpass", "PT
|
||||
Sans Narrow", "Raleway", "Times New Roman".
|
||||
size
|
||||
|
||||
|
||||
Returns
|
||||
-------
|
||||
Textfont
|
||||
"""
|
||||
super(Textfont, self).__init__("textfont")
|
||||
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
# Validate arg
|
||||
# ------------
|
||||
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.mapbox.layer.symbol.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.layout.mapbox.layer.symbol.Textfont`"""
|
||||
)
|
||||
|
||||
# Handle skip_invalid
|
||||
# -------------------
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
# Populate data dict with properties
|
||||
# ----------------------------------
|
||||
_v = arg.pop("color", None)
|
||||
_v = color if color is not None else _v
|
||||
if _v is not None:
|
||||
self["color"] = _v
|
||||
_v = arg.pop("family", None)
|
||||
_v = family if family is not None else _v
|
||||
if _v is not None:
|
||||
self["family"] = _v
|
||||
_v = arg.pop("size", None)
|
||||
_v = size if size is not None else _v
|
||||
if _v is not None:
|
||||
self["size"] = _v
|
||||
|
||||
# Process unknown kwargs
|
||||
# ----------------------
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
|
||||
# Reset skip_invalid
|
||||
# ------------------
|
||||
self._skip_invalid = False
|
||||
Reference in New Issue
Block a user