CircleLayerState

The state holder for CircleLayer's layer properties.

See also

Constructors

Link copied to clipboard

Construct an default CircleLayerState.

Properties

Link copied to clipboard

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Setting a negative value renders the blur as an inner glow effect. Default value: 0.

Link copied to clipboard

Defines the transition of circleBlur. Default value: 0.

Link copied to clipboard

The fill color of the circle. Default value: "#000000".

Link copied to clipboard

Defines the transition of circleColor. Default value: "#000000".

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard

Defines the transition of circleEmissiveStrength. Default value: 0. Minimum value: 0.

Link copied to clipboard

The opacity at which the circle will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

Defines the transition of circleOpacity. Default value: 1. Value range: 0, 1

Link copied to clipboard

Orientation of circle when map is pitched. Default value: "viewport".

Link copied to clipboard

Controls the scaling behavior of the circle when the map is pitched. Default value: "map".

Link copied to clipboard

Circle radius. Default value: 5. Minimum value: 0.

Link copied to clipboard

Defines the transition of circleRadius. Default value: 5. Minimum value: 0.

Link copied to clipboard

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

Link copied to clipboard

The stroke color of the circle. Default value: "#000000".

Link copied to clipboard

Defines the transition of circleStrokeColor. Default value: "#000000".

Link copied to clipboard

The opacity of the circle's stroke. Default value: 1. Value range: 0, 1

Link copied to clipboard

Defines the transition of circleStrokeOpacity. Default value: 1. Value range: 0, 1

Link copied to clipboard

The width of the circle's stroke. Strokes are placed outside of the circle-radius. Default value: 0. Minimum value: 0.

Link copied to clipboard

Defines the transition of circleStrokeWidth. Default value: 0. Minimum value: 0.

Link copied to clipboard

The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0.

Link copied to clipboard

Controls the frame of reference for circle-translate. Default value: "map".

Link copied to clipboard

Defines the transition of circleTranslate. Default value: 0,0.

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".