LocationIndicatorLayerState

The state holder for LocationIndicatorLayer's layer properties.

See also

Constructors

Link copied to clipboard

Properties

Link copied to clipboard

The accuracy, in meters, of the position source used to retrieve the position of the location indicator. Default value: 0.

Link copied to clipboard

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

Link copied to clipboard

Defines the transition of accuracyRadiusBorderColor. Default value: "#ffffff".

Link copied to clipboard

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

Link copied to clipboard

Defines the transition of accuracyRadiusColor. Default value: "#ffffff".

Link copied to clipboard

Defines the transition of accuracyRadius. Default value: 0.

Link copied to clipboard

The bearing of the location indicator. Values under 0.01 degree variation are ignored. Default value: 0.

Link copied to clipboard

Name of image in sprite to use as the middle of the location indicator.

Link copied to clipboard

The size of the bearing image, as a scale factor applied to the size of the specified image. Default value: 1.

Link copied to clipboard

Defines the transition of bearingImageSize. Default value: 1.

Link copied to clipboard

Defines the transition of bearing. Default value: 0.

Link copied to clipboard

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

Link copied to clipboard

Defines the transition of emphasisCircleColor. Default value: "#ffffff".

Link copied to clipboard

Specifies a glow effect range of the emphasis circle, in pixels. If 0,0 values are provided, it renders the circle as a solid color. The first value specifies the start of the glow effect where it is equal to the circle's color, the second is the end, where it's fully transparent. Between the two values the effect is linearly faded out. Default value: 0,0.

Link copied to clipboard

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

Link copied to clipboard

The radius, in pixel, of the circle emphasizing the indicator, drawn between the accuracy radius and the indicator shadow. Default value: 0.

Link copied to clipboard

Defines the transition of emphasisCircleRadius. Default value: 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 displacement off the center of the top image and the shadow image when the pitch of the map is greater than 0. This helps producing a three-dimensional appearence. Default value: "0".

Link copied to clipboard

An array of latitude, longitude, altitude position of the location indicator. Values under 0.000001 variation are ignored. Default value: 0,0,0.

Link copied to clipboard

The opacity of the entire location indicator layer. Default value: 1. Value range: 0, 1

Link copied to clipboard

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

Link copied to clipboard

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

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

The amount of the perspective compensation, between 0 and 1. A value of 1 produces a location indicator of constant width across the screen. A value of 0 makes it scale naturally according to the viewing projection. Default value: "0.85".

Link copied to clipboard

Name of image in sprite to use as the background of the location indicator.

Link copied to clipboard

The size of the shadow image, as a scale factor applied to the size of the specified image. Default value: 1.

Link copied to clipboard

Defines the transition of shadowImageSize. Default value: 1.

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

Name of image in sprite to use as the top of the location indicator.

Link copied to clipboard

The size of the top image, as a scale factor applied to the size of the specified image. Default value: 1.

Link copied to clipboard

Defines the transition of topImageSize. Default value: 1.

Link copied to clipboard

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