mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated/LocationIndicatorLayerState

LocationIndicatorLayerState

@Stable

class LocationIndicatorLayerState

The state holder for LocationIndicatorLayer's layer properties.

Constructors

LocationIndicatorLayerState

fun LocationIndicatorLayerState()

Construct an default LocationIndicatorLayerState.

Properties

accuracyRadius

var accuracyRadius: DoubleValue

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

accuracyRadiusBorderColor

var accuracyRadiusBorderColor: ColorValue

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

accuracyRadiusBorderColorTransition

var accuracyRadiusBorderColorTransition: Transition

Defines the transition of accuracyRadiusBorderColor.

accuracyRadiusBorderColorUseTheme

@MapboxExperimental

var accuracyRadiusBorderColorUseTheme: StringValue

Overrides applying of color theme for accuracyRadiusBorderColor if "none" is set. To follow default theme "default" should be set. Default value: "default".

accuracyRadiusColor

var accuracyRadiusColor: ColorValue

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

accuracyRadiusColorTransition

var accuracyRadiusColorTransition: Transition

Defines the transition of accuracyRadiusColor.

accuracyRadiusColorUseTheme

@MapboxExperimental

var accuracyRadiusColorUseTheme: StringValue

Overrides applying of color theme for accuracyRadiusColor if "none" is set. To follow default theme "default" should be set. Default value: "default".

accuracyRadiusTransition

var accuracyRadiusTransition: Transition

Defines the transition of accuracyRadius.

bearing

var bearing: DoubleValue

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

bearingImage

var bearingImage: ImageValue

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

bearingImageSize

var bearingImageSize: DoubleValue

The size of the bearing image, as a scale factor applied to the size of the specified image. Default value: 1. The unit of bearingImageSize is in factor of the original icon size.

bearingImageSizeTransition

var bearingImageSizeTransition: Transition

Defines the transition of bearingImageSize.

bearingTransition

var bearingTransition: Transition

Defines the transition of bearing.

emphasisCircleColor

var emphasisCircleColor: ColorValue

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

emphasisCircleColorTransition

var emphasisCircleColorTransition: Transition

Defines the transition of emphasisCircleColor.

emphasisCircleColorUseTheme

@MapboxExperimental

var emphasisCircleColorUseTheme: StringValue

Overrides applying of color theme for emphasisCircleColor if "none" is set. To follow default theme "default" should be set. Default value: "default".

emphasisCircleGlowRange

var emphasisCircleGlowRange: DoubleRangeValue

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.

emphasisCircleGlowRangeTransition

var emphasisCircleGlowRangeTransition: Transition

Defines the transition of emphasisCircleGlowRange.

emphasisCircleRadius

var emphasisCircleRadius: DoubleValue

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

emphasisCircleRadiusTransition

var emphasisCircleRadiusTransition: Transition

Defines the transition of emphasisCircleRadius.

filter

var filter: Filter

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.

imagePitchDisplacement

var imagePitchDisplacement: DoubleValue

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". The unit of imagePitchDisplacement is in pixels.

location

var location: DoubleListValue

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

locationIndicatorOpacity

var locationIndicatorOpacity: DoubleValue

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

locationIndicatorOpacityTransition

var locationIndicatorOpacityTransition: Transition

Defines the transition of locationIndicatorOpacity.

locationTransition

var locationTransition: Transition

Defines the transition of location.

maxZoom

var maxZoom: LongValue

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

minZoom

var minZoom: LongValue

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

perspectiveCompensation

var perspectiveCompensation: DoubleValue

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

shadowImage

var shadowImage: ImageValue

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

shadowImageSize

var shadowImageSize: DoubleValue

The size of the shadow image, as a scale factor applied to the size of the specified image. Default value: 1. The unit of shadowImageSize is in factor of the original icon size.

shadowImageSizeTransition

var shadowImageSizeTransition: Transition

Defines the transition of shadowImageSize.

sourceLayer

var sourceLayer: StringValue

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

topImage

var topImage: ImageValue

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

topImageSize

var topImageSize: DoubleValue

The size of the top image, as a scale factor applied to the size of the specified image. Default value: 1. The unit of topImageSize is in factor of the original icon size.

topImageSizeTransition

var topImageSizeTransition: Transition

Defines the transition of topImageSize.

visibility

var visibility: VisibilityValue

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

LocationIndicatorLayerState

See also

Constructors

Properties