LocationIndicatorLayer

Location Indicator layer.

See also

Parameters

layerId

the ID of the layer

Constructors

Link copied to clipboard

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
open override fun accuracyRadius(accuracyRadius: Expression): LocationIndicatorLayer
open override fun accuracyRadius(accuracyRadius: Double): LocationIndicatorLayer

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

Link copied to clipboard
open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: Expression): LocationIndicatorLayer
open override fun accuracyRadiusBorderColor(@ColorInt accuracyRadiusBorderColor: Int): LocationIndicatorLayer
open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: String): LocationIndicatorLayer

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

Set the AccuracyRadiusBorderColor property transition options

Link copied to clipboard
open override fun accuracyRadiusColor(accuracyRadiusColor: Expression): LocationIndicatorLayer
open override fun accuracyRadiusColor(@ColorInt accuracyRadiusColor: Int): LocationIndicatorLayer
open override fun accuracyRadiusColor(accuracyRadiusColor: String): LocationIndicatorLayer

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

Set the AccuracyRadiusColor property transition options

Link copied to clipboard

Set the AccuracyRadius property transition options

Link copied to clipboard
open override fun bearing(bearing: Expression): LocationIndicatorLayer
open override fun bearing(bearing: Double): LocationIndicatorLayer

The bearing of the location indicator. Default value: 0.

Link copied to clipboard
open override fun bearingImage(bearingImage: Expression): LocationIndicatorLayer
open override fun bearingImage(bearingImage: String): LocationIndicatorLayer

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

Link copied to clipboard
open override fun bearingImageSize(bearingImageSize: Expression): LocationIndicatorLayer
open override fun bearingImageSize(bearingImageSize: Double): LocationIndicatorLayer

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

Set the BearingImageSize property transition options

Link copied to clipboard

Set the Bearing property transition options

Link copied to clipboard
fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

open override fun bindTo(delegate: MapboxStyleManager, position: LayerPosition?)

Bind the layer to the map controller.

Link copied to clipboard
open override fun emphasisCircleColor(emphasisCircleColor: Expression): LocationIndicatorLayer
open override fun emphasisCircleColor(@ColorInt emphasisCircleColor: Int): LocationIndicatorLayer
open override fun emphasisCircleColor(emphasisCircleColor: String): LocationIndicatorLayer

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

Set the EmphasisCircleColor property transition options

Link copied to clipboard
open override fun emphasisCircleRadius(emphasisCircleRadius: Expression): LocationIndicatorLayer
open override fun emphasisCircleRadius(emphasisCircleRadius: Double): LocationIndicatorLayer

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

Set the EmphasisCircleRadius property transition options

Link copied to clipboard
open override fun imagePitchDisplacement(imagePitchDisplacement: Expression): LocationIndicatorLayer
open override fun imagePitchDisplacement(imagePitchDisplacement: Double): LocationIndicatorLayer

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
open override fun location(location: Expression): LocationIndicatorLayer
open override fun location(location: List<Double>): LocationIndicatorLayer

An array of latitude, longitude, altitude position of the location indicator. Default value: 0,0,0.

Link copied to clipboard
open override fun locationIndicatorOpacity(locationIndicatorOpacity: Expression): LocationIndicatorLayer
open override fun locationIndicatorOpacity(locationIndicatorOpacity: Double): LocationIndicatorLayer

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

Link copied to clipboard

Set the LocationIndicatorOpacity property transition options

Link copied to clipboard

Set the Location property transition options

Link copied to clipboard
open override fun maxZoom(maxZoom: Double): LocationIndicatorLayer

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

Link copied to clipboard
open override fun minZoom(minZoom: Double): LocationIndicatorLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override fun perspectiveCompensation(perspectiveCompensation: Expression): LocationIndicatorLayer
open override fun perspectiveCompensation(perspectiveCompensation: Double): LocationIndicatorLayer

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
open override fun shadowImage(shadowImage: Expression): LocationIndicatorLayer
open override fun shadowImage(shadowImage: String): LocationIndicatorLayer

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

Link copied to clipboard
open override fun shadowImageSize(shadowImageSize: Expression): LocationIndicatorLayer
open override fun shadowImageSize(shadowImageSize: Double): LocationIndicatorLayer

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

Set the ShadowImageSize property transition options

Link copied to clipboard
open override fun slot(slot: String): LocationIndicatorLayer

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
open override fun topImage(topImage: Expression): LocationIndicatorLayer
open override fun topImage(topImage: String): LocationIndicatorLayer

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

Link copied to clipboard
open override fun topImageSize(topImageSize: Expression): LocationIndicatorLayer
open override fun topImageSize(topImageSize: Double): LocationIndicatorLayer

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

Set the TopImageSize property transition options

Link copied to clipboard
open override fun visibility(visibility: Expression): LocationIndicatorLayer
open override fun visibility(visibility: Visibility): LocationIndicatorLayer

Whether this layer is displayed.

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

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

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

Transition options for AccuracyRadiusBorderColor.

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

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

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

Transition options for AccuracyRadiusColor.

Link copied to clipboard

Transition options for AccuracyRadius.

Link copied to clipboard

The bearing of the location indicator. Default value: 0.

Link copied to clipboard

The bearing of the location indicator. 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

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

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

Transition options for BearingImageSize.

Link copied to clipboard

Transition options for Bearing.

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

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

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

Transition options for EmphasisCircleColor.

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

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

Transition options for EmphasisCircleRadius.

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

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
open override val layerId: String
Link copied to clipboard

An array of latitude, longitude, altitude position of the location indicator. Default value: 0,0,0.

Link copied to clipboard

An array of latitude, longitude, altitude position of the location indicator. 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

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

Link copied to clipboard

Transition options for LocationIndicatorOpacity.

Link copied to clipboard

Transition options for Location.

Link copied to clipboard
open override val maxZoom: Double?

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

Link copied to clipboard
open override val minZoom: Double?

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

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

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

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

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

Transition options for ShadowImageSize.

Link copied to clipboard
open override val slot: String?

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard

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

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

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

Transition options for TopImageSize.

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.