ClipLayerState

The state holder for ClipLayer's layer properties.

See also

Constructors

Link copied to clipboard

Construct an default ClipLayerState.

Properties

Link copied to clipboard

Removes content from layers with the specified scope. By default all layers are affected. For example specifying basemap will only remove content from the Mapbox Standard style layers which have the same scope Default value: [].

Link copied to clipboard

Layer types that will also be removed if fallen below this clip layer. Default value: [].

Link copied to clipboard

An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...] expression is not supported in filter expressions. The ["pitch"] and ["distance-from-center"] expressions are supported only for filter expressions on the symbol layer.

Link copied to clipboard

The interactions associated with this layer.

Link copied to clipboard

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. Value range: 0, 24

Link copied to clipboard

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Value range: 0, 24

Link copied to clipboard

Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

Link copied to clipboard

Whether this layer is displayed. Default value: "visible".