LocationIndicatorLayer

class LocationIndicatorLayer(layerId: String) : Layer, LocationIndicatorLayerDsl

Location Indicator layer.

See also

Parameters

layerId

the ID of the layer

Constructors

LocationIndicatorLayer
Link copied to clipboard
fun LocationIndicatorLayer(layerId: String)

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

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

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

accuracyRadiusBorderColorTransition
Link copied to clipboard
open override fun accuracyRadiusBorderColorTransition(options: StyleTransition): LocationIndicatorLayer

Set the AccuracyRadiusBorderColor property transition options

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

accuracyRadiusColorTransition
Link copied to clipboard
open override fun accuracyRadiusColorTransition(options: StyleTransition): LocationIndicatorLayer

Set the AccuracyRadiusColor property transition options

open override fun accuracyRadiusColorTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
accuracyRadiusTransition
Link copied to clipboard
open override fun accuracyRadiusTransition(options: StyleTransition): LocationIndicatorLayer

Set the AccuracyRadius property transition options

open override fun accuracyRadiusTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
bearing
Link copied to clipboard
open override fun bearing(bearing: Expression): LocationIndicatorLayer
open override fun bearing(bearing: Double): LocationIndicatorLayer

The bearing of the location indicator.

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

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

bearingImageSizeTransition
Link copied to clipboard
open override fun bearingImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

Set the BearingImageSize property transition options

open override fun bearingImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
bearingTransition
Link copied to clipboard
open override fun bearingTransition(options: StyleTransition): LocationIndicatorLayer

Set the Bearing property transition options

open override fun bearingTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

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

Bind the layer to the map controller.

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

emphasisCircleColorTransition
Link copied to clipboard
open override fun emphasisCircleColorTransition(options: StyleTransition): LocationIndicatorLayer

Set the EmphasisCircleColor property transition options

open override fun emphasisCircleColorTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
emphasisCircleRadius
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.

emphasisCircleRadiusTransition
Link copied to clipboard
open override fun emphasisCircleRadiusTransition(options: StyleTransition): LocationIndicatorLayer

Set the EmphasisCircleRadius property transition options

open override fun emphasisCircleRadiusTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
imagePitchDisplacement
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.

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

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

locationIndicatorOpacityTransition
Link copied to clipboard
open override fun locationIndicatorOpacityTransition(options: StyleTransition): LocationIndicatorLayer

Set the LocationIndicatorOpacity property transition options

locationTransition
Link copied to clipboard
open override fun locationTransition(options: StyleTransition): LocationIndicatorLayer

Set the Location property transition options

open override fun locationTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
maxZoom
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.

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

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

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

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

shadowImageSizeTransition
Link copied to clipboard
open override fun shadowImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

Set the ShadowImageSize property transition options

open override fun shadowImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
topImage
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.

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

topImageSizeTransition
Link copied to clipboard
open override fun topImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

Set the TopImageSize property transition options

open override fun topImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): LocationIndicatorLayer

Whether this layer is displayed.

Properties

accuracyRadius
Link copied to clipboard
val accuracyRadius: Double?

The accuracy, in meters, of the position source used to retrieve the position of the location indicator.

accuracyRadiusAsExpression
Link copied to clipboard
val accuracyRadiusAsExpression: Expression?

The accuracy, in meters, of the position source used to retrieve the position of the location indicator.

accuracyRadiusBorderColor
Link copied to clipboard
val accuracyRadiusBorderColor: String?

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly.

accuracyRadiusBorderColorAsColorInt
Link copied to clipboard
val accuracyRadiusBorderColorAsColorInt: Int?

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly.

accuracyRadiusBorderColorAsExpression
Link copied to clipboard
val accuracyRadiusBorderColorAsExpression: Expression?

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly.

accuracyRadiusBorderColorTransition
Link copied to clipboard
val accuracyRadiusBorderColorTransition: StyleTransition?

Transition options for AccuracyRadiusBorderColor.

accuracyRadiusColor
Link copied to clipboard
val accuracyRadiusColor: String?

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly.

accuracyRadiusColorAsColorInt
Link copied to clipboard
val accuracyRadiusColorAsColorInt: Int?

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly.

accuracyRadiusColorAsExpression
Link copied to clipboard
val accuracyRadiusColorAsExpression: Expression?

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly.

accuracyRadiusColorTransition
Link copied to clipboard
val accuracyRadiusColorTransition: StyleTransition?

Transition options for AccuracyRadiusColor.

accuracyRadiusTransition
Link copied to clipboard
val accuracyRadiusTransition: StyleTransition?

Transition options for AccuracyRadius.

bearing
Link copied to clipboard
val bearing: Double?

The bearing of the location indicator.

bearingAsExpression
Link copied to clipboard
val bearingAsExpression: Expression?

The bearing of the location indicator.

bearingImage
Link copied to clipboard
val bearingImage: String?

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

bearingImageAsExpression
Link copied to clipboard
val bearingImageAsExpression: Expression?

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

bearingImageSize
Link copied to clipboard
val bearingImageSize: Double?

The size of the bearing image, as a scale factor applied to the size of the specified image.

bearingImageSizeAsExpression
Link copied to clipboard
val bearingImageSizeAsExpression: Expression?

The size of the bearing image, as a scale factor applied to the size of the specified image.

bearingImageSizeTransition
Link copied to clipboard
val bearingImageSizeTransition: StyleTransition?

Transition options for BearingImageSize.

bearingTransition
Link copied to clipboard
val bearingTransition: StyleTransition?

Transition options for Bearing.

emphasisCircleColor
Link copied to clipboard
val emphasisCircleColor: String?

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly.

emphasisCircleColorAsColorInt
Link copied to clipboard
val emphasisCircleColorAsColorInt: Int?

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly.

emphasisCircleColorAsExpression
Link copied to clipboard
val emphasisCircleColorAsExpression: Expression?

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly.

emphasisCircleColorTransition
Link copied to clipboard
val emphasisCircleColorTransition: StyleTransition?

Transition options for EmphasisCircleColor.

emphasisCircleRadius
Link copied to clipboard
val emphasisCircleRadius: Double?

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

emphasisCircleRadiusAsExpression
Link copied to clipboard
val emphasisCircleRadiusAsExpression: Expression?

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

emphasisCircleRadiusTransition
Link copied to clipboard
val emphasisCircleRadiusTransition: StyleTransition?

Transition options for EmphasisCircleRadius.

imagePitchDisplacement
Link copied to clipboard
val imagePitchDisplacement: Double?

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.

imagePitchDisplacementAsExpression
Link copied to clipboard
val imagePitchDisplacementAsExpression: Expression?

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.

layerId
Link copied to clipboard
open override val layerId: String
location
Link copied to clipboard
val location: List<Double>?

An array of latitude, longitude, altitude position of the location indicator.

locationAsExpression
Link copied to clipboard
val locationAsExpression: Expression?

An array of latitude, longitude, altitude position of the location indicator.

locationIndicatorOpacity
Link copied to clipboard
val locationIndicatorOpacity: Double?

The opacity of the entire location indicator layer.

locationIndicatorOpacityAsExpression
Link copied to clipboard
val locationIndicatorOpacityAsExpression: Expression?

The opacity of the entire location indicator layer.

locationIndicatorOpacityTransition
Link copied to clipboard
val locationIndicatorOpacityTransition: StyleTransition?

Transition options for LocationIndicatorOpacity.

locationTransition
Link copied to clipboard
val locationTransition: StyleTransition?

Transition options for Location.

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

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

perspectiveCompensation
Link copied to clipboard
val perspectiveCompensation: Double?

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.

perspectiveCompensationAsExpression
Link copied to clipboard
val perspectiveCompensationAsExpression: Expression?

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.

shadowImage
Link copied to clipboard
val shadowImage: String?

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

shadowImageAsExpression
Link copied to clipboard
val shadowImageAsExpression: Expression?

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

shadowImageSize
Link copied to clipboard
val shadowImageSize: Double?

The size of the shadow image, as a scale factor applied to the size of the specified image.

shadowImageSizeAsExpression
Link copied to clipboard
val shadowImageSizeAsExpression: Expression?

The size of the shadow image, as a scale factor applied to the size of the specified image.

shadowImageSizeTransition
Link copied to clipboard
val shadowImageSizeTransition: StyleTransition?

Transition options for ShadowImageSize.

topImage
Link copied to clipboard
val topImage: String?

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

topImageAsExpression
Link copied to clipboard
val topImageAsExpression: Expression?

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

topImageSize
Link copied to clipboard
val topImageSize: Double?

The size of the top image, as a scale factor applied to the size of the specified image.

topImageSizeAsExpression
Link copied to clipboard
val topImageSizeAsExpression: Expression?

The size of the top image, as a scale factor applied to the size of the specified image.

topImageSizeTransition
Link copied to clipboard
val topImageSizeTransition: StyleTransition?

Transition options for TopImageSize.

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.