import _plotly_utils.basevalidators
class LayersValidator(_plotly_utils.basevalidators.CompoundArrayValidator):
def __init__(self, plotly_name="layers", parent_name="layout.mapbox", **kwargs):
super(LayersValidator, self).__init__(
plotly_name=plotly_name,
parent_name=parent_name,
data_class_str=kwargs.pop("data_class_str", "Layer"),
data_docs=kwargs.pop(
"data_docs",
"""
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.laye
r.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.laye
r.Fill` instance or dict with compatible
properties
line
:class:`plotly.graph_objects.layout.mapbox.laye
r.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.laye
r.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
""",
),
**kwargs,
)