def __init__(self,
arg=None,
below=None,
circle=None,
color=None,
fill=None,
line=None,
name=None,
opacity=None,
source=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 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
plotly.graph_objs.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 If `type` is
"line", color corresponds to the line color If `type`
is "fill", color corresponds to the fill color If
`type` is "symbol", color corresponds to the icon color
fill
plotly.graph_objs.layout.mapbox.layer.Fill instance or
dict with compatible properties
line
plotly.graph_objs.layout.mapbox.layer.Line instance or
dict with compatible properties
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.
source
Sets the source data for this layer. Source can be
either a URL, a geojson object (with `sourcetype` set
to "geojson") or an array of tile URLS (with
`sourcetype` set to "vector").
sourcelayer
Specifies the layer to use from a vector tile source.
Required for "vector" source type that supports
multiple layers.
sourcetype
Sets the source type for this layer. Support for
"raster", "image" and "video" source types is coming
soon.
symbol
plotly.graph_objs.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. Support for "raster", "background"
types is coming soon. Note that "line" and "fill" are
not compatible with Point GeoJSON geometries.
visible
Determines whether this layer is displayed
Returns
-------
Layer
"""
super(Layer, self).__init__('layers')
# 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 plotly.graph_objs.layout.mapbox.Layer""")
# Handle skip_invalid
# -------------------
self._skip_invalid = kwargs.pop('skip_invalid', False)
# Import validators
# -----------------
from plotly.validators.layout.mapbox import (layer as v_layer)
# Initialize validators
# ---------------------
self._validators['below'] = v_layer.BelowValidator()
self._validators['circle'] = v_layer.CircleValidator()
self._validators['color'] = v_layer.ColorValidator()
self._validators['fill'] = v_layer.FillValidator()
self._validators['line'] = v_layer.LineValidator()
self._validators['name'] = v_layer.NameValidator()
self._validators['opacity'] = v_layer.OpacityValidator()
self._validators['source'] = v_layer.SourceValidator()
self._validators['sourcelayer'] = v_layer.SourcelayerValidator()
self._validators['sourcetype'] = v_layer.SourcetypeValidator()
self._validators['symbol'] = v_layer.SymbolValidator()
self._validators[
'templateitemname'] = v_layer.TemplateitemnameValidator()
self._validators['type'] = v_layer.TypeValidator()
self._validators['visible'] = v_layer.VisibleValidator()
# Populate data dict with properties
# ----------------------------------
_v = arg.pop('below', None)
self['below'] = below if below is not None else _v
_v = arg.pop('circle', None)
self['circle'] = circle if circle is not None else _v
_v = arg.pop('color', None)
self['color'] = color if color is not None else _v
_v = arg.pop('fill', None)
self['fill'] = fill if fill is not None else _v
_v = arg.pop('line', None)
self['line'] = line if line is not None else _v
_v = arg.pop('name', None)
self['name'] = name if name is not None else _v
_v = arg.pop('opacity', None)
self['opacity'] = opacity if opacity is not None else _v
_v = arg.pop('source', None)
self['source'] = source if source is not None else _v
_v = arg.pop('sourcelayer', None)
self['sourcelayer'] = sourcelayer if sourcelayer is not None else _v
_v = arg.pop('sourcetype', None)
self['sourcetype'] = sourcetype if sourcetype is not None else _v
_v = arg.pop('symbol', None)
self['symbol'] = symbol if symbol is not None else _v
_v = arg.pop('templateitemname', None)
self[
'templateitemname'] = templateitemname if templateitemname is not None else _v
_v = arg.pop('type', None)
self['type'] = type if type is not None else _v
_v = arg.pop('visible', None)
self['visible'] = visible if visible is not None else _v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
# Reset skip_invalid
# ------------------
self._skip_invalid = False
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")
# 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)
# Import validators
# -----------------
from plotly.validators.layout.mapbox import layer as v_layer
# Initialize validators
# ---------------------
self._validators["below"] = v_layer.BelowValidator()
self._validators["circle"] = v_layer.CircleValidator()
self._validators["color"] = v_layer.ColorValidator()
self._validators["coordinates"] = v_layer.CoordinatesValidator()
self._validators["fill"] = v_layer.FillValidator()
self._validators["line"] = v_layer.LineValidator()
self._validators["maxzoom"] = v_layer.MaxzoomValidator()
self._validators["minzoom"] = v_layer.MinzoomValidator()
self._validators["name"] = v_layer.NameValidator()
self._validators["opacity"] = v_layer.OpacityValidator()
self._validators["source"] = v_layer.SourceValidator()
self._validators[
"sourceattribution"] = v_layer.SourceattributionValidator()
self._validators["sourcelayer"] = v_layer.SourcelayerValidator()
self._validators["sourcetype"] = v_layer.SourcetypeValidator()
self._validators["symbol"] = v_layer.SymbolValidator()
self._validators[
"templateitemname"] = v_layer.TemplateitemnameValidator()
self._validators["type"] = v_layer.TypeValidator()
self._validators["visible"] = v_layer.VisibleValidator()
# Populate data dict with properties
# ----------------------------------
_v = arg.pop("below", None)
self["below"] = below if below is not None else _v
_v = arg.pop("circle", None)
self["circle"] = circle if circle is not None else _v
_v = arg.pop("color", None)
self["color"] = color if color is not None else _v
_v = arg.pop("coordinates", None)
self["coordinates"] = coordinates if coordinates is not None else _v
_v = arg.pop("fill", None)
self["fill"] = fill if fill is not None else _v
_v = arg.pop("line", None)
self["line"] = line if line is not None else _v
_v = arg.pop("maxzoom", None)
self["maxzoom"] = maxzoom if maxzoom is not None else _v
_v = arg.pop("minzoom", None)
self["minzoom"] = minzoom if minzoom is not None else _v
_v = arg.pop("name", None)
self["name"] = name if name is not None else _v
_v = arg.pop("opacity", None)
self["opacity"] = opacity if opacity is not None else _v
_v = arg.pop("source", None)
self["source"] = source if source is not None else _v
_v = arg.pop("sourceattribution", None)
self["sourceattribution"] = (sourceattribution
if sourceattribution is not None else _v)
_v = arg.pop("sourcelayer", None)
self["sourcelayer"] = sourcelayer if sourcelayer is not None else _v
_v = arg.pop("sourcetype", None)
self["sourcetype"] = sourcetype if sourcetype is not None else _v
_v = arg.pop("symbol", None)
self["symbol"] = symbol if symbol is not None else _v
_v = arg.pop("templateitemname", None)
self["templateitemname"] = (templateitemname
if templateitemname is not None else _v)
_v = arg.pop("type", None)
self["type"] = type if type is not None else _v
_v = arg.pop("visible", None)
self["visible"] = visible if visible is not None else _v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
# Reset skip_invalid
# ------------------
self._skip_invalid = False