LocationIndicatorLayer

Location Indicator layer.

class LocationIndicatorLayer(layerId: String) : Layer, LocationIndicatorLayerDsl

See also

Parameters

layerId

the ID of the layer

Constructors

LocationIndicatorLayer
Link copied to clipboard

the ID of the layer

fun LocationIndicatorLayer(layerId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

accuracyRadius
Link copied to clipboard

Set the AccuracyRadius property

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

Set the AccuracyRadiusBorderColor property

open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: Expression): LocationIndicatorLayer
open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: String): LocationIndicatorLayer

Set the AccuracyRadiusBorderColor property.

open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: Int): LocationIndicatorLayer
accuracyRadiusBorderColorTransition
Link copied to clipboard

Set the AccuracyRadiusBorderColor property transition options

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

Set the AccuracyRadiusColor property

open override fun accuracyRadiusColor(accuracyRadiusColor: Expression): LocationIndicatorLayer
open override fun accuracyRadiusColor(accuracyRadiusColor: String): LocationIndicatorLayer

Set the AccuracyRadiusColor property.

open override fun accuracyRadiusColor(accuracyRadiusColor: Int): LocationIndicatorLayer
accuracyRadiusColorTransition
Link copied to clipboard

Set the AccuracyRadiusColor property transition options

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

Set the AccuracyRadius property transition options

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

Set the Bearing property

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

Set the BearingImage property

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

Set the BearingImageSize property

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

Set the BearingImageSize property transition options

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

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
emphasisCircleColor
Link copied to clipboard

Set the EmphasisCircleColor property

open override fun emphasisCircleColor(emphasisCircleColor: Expression): LocationIndicatorLayer
open override fun emphasisCircleColor(emphasisCircleColor: String): LocationIndicatorLayer

Set the EmphasisCircleColor property.

open override fun emphasisCircleColor(emphasisCircleColor: Int): LocationIndicatorLayer
emphasisCircleColorTransition
Link copied to clipboard

Set the EmphasisCircleColor property transition options

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

Set the EmphasisCircleRadius property

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

Set the EmphasisCircleRadius property transition options

open override fun emphasisCircleRadiusTransition(options: StyleTransition): LocationIndicatorLayer
open override fun emphasisCircleRadiusTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getCachedLayerProperties
Link copied to clipboard
override fun getCachedLayerProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
imagePitchDisplacement
Link copied to clipboard

Set the ImagePitchDisplacement property

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

Set the Location property

open override fun location(location: Expression): LocationIndicatorLayer
open override fun location(location: List<Double>): LocationIndicatorLayer
locationTransition
Link copied to clipboard

Set the Location property transition options

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

Set the maxzoom property

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

Set the minzoom property

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

Set the PerspectiveCompensation property

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

Set the ShadowImage property

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

Set the ShadowImageSize property

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

Set the ShadowImageSize property transition options

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

Set the TopImage property

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

Set the TopImageSize property

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

Set the TopImageSize property transition options

open override fun topImageSizeTransition(options: StyleTransition): LocationIndicatorLayer
open override fun topImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): LocationIndicatorLayer

Properties

accuracyRadius
Link copied to clipboard

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

val accuracyRadius: Double?
accuracyRadiusAsExpression
Link copied to clipboard

This is an Expression representation of "accuracy-radius".

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

val accuracyRadiusAsExpression: Expression?
accuracyRadiusBorderColor
Link copied to clipboard

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

val accuracyRadiusBorderColor: String?
accuracyRadiusBorderColorAsColorInt
Link copied to clipboard

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

val accuracyRadiusBorderColorAsColorInt: Int?
accuracyRadiusBorderColorAsExpression
Link copied to clipboard

This is an Expression representation of "accuracy-radius-border-color".

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

val accuracyRadiusBorderColorAsExpression: Expression?
accuracyRadiusBorderColorTransition
Link copied to clipboard

Transition options for AccuracyRadiusBorderColor.

val accuracyRadiusBorderColorTransition: StyleTransition?
accuracyRadiusColor
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.

val accuracyRadiusColor: String?
accuracyRadiusColorAsColorInt
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.

val accuracyRadiusColorAsColorInt: Int?
accuracyRadiusColorAsExpression
Link copied to clipboard

This is an Expression representation of "accuracy-radius-color".

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

val accuracyRadiusColorAsExpression: Expression?
accuracyRadiusColorTransition
Link copied to clipboard

Transition options for AccuracyRadiusColor.

val accuracyRadiusColorTransition: StyleTransition?
accuracyRadiusTransition
Link copied to clipboard

Transition options for AccuracyRadius.

val accuracyRadiusTransition: StyleTransition?
bearing
Link copied to clipboard

The bearing of the location indicator.

val bearing: Double?
bearingAsExpression
Link copied to clipboard

This is an Expression representation of "bearing".

The bearing of the location indicator.

val bearingAsExpression: Expression?
bearingImage
Link copied to clipboard

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

val bearingImage: String?
bearingImageAsExpression
Link copied to clipboard

This is an Expression representation of "bearing-image".

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

val bearingImageAsExpression: Expression?
bearingImageSize
Link copied to clipboard

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

val bearingImageSize: Double?
bearingImageSizeAsExpression
Link copied to clipboard

This is an Expression representation of "bearing-image-size".

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

val bearingImageSizeAsExpression: Expression?
bearingImageSizeTransition
Link copied to clipboard

Transition options for BearingImageSize.

val bearingImageSizeTransition: StyleTransition?
emphasisCircleColor
Link copied to clipboard

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

val emphasisCircleColor: String?
emphasisCircleColorAsColorInt
Link copied to clipboard

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

val emphasisCircleColorAsColorInt: Int?
emphasisCircleColorAsExpression
Link copied to clipboard

This is an Expression representation of "emphasis-circle-color".

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

val emphasisCircleColorAsExpression: Expression?
emphasisCircleColorTransition
Link copied to clipboard

Transition options for EmphasisCircleColor.

val emphasisCircleColorTransition: StyleTransition?
emphasisCircleRadius
Link copied to clipboard

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

val emphasisCircleRadius: Double?
emphasisCircleRadiusAsExpression
Link copied to clipboard

This is an Expression representation of "emphasis-circle-radius".

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

val emphasisCircleRadiusAsExpression: Expression?
emphasisCircleRadiusTransition
Link copied to clipboard

Transition options for EmphasisCircleRadius.

val emphasisCircleRadiusTransition: StyleTransition?
imagePitchDisplacement
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.

val imagePitchDisplacement: Double?
imagePitchDisplacementAsExpression
Link copied to clipboard

This is an Expression representation of "image-pitch-displacement".

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.

val imagePitchDisplacementAsExpression: Expression?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
location
Link copied to clipboard

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

val location: List<Double>?
locationAsExpression
Link copied to clipboard

This is an Expression representation of "location".

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

val locationAsExpression: Expression?
locationTransition
Link copied to clipboard

Transition options for Location.

val locationTransition: StyleTransition?
maxZoom
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.

Range: minimum: 0 maximum: 24

open override val maxZoom: Double?
minZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val minZoom: Double?
perspectiveCompensation
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.

val perspectiveCompensation: Double?
perspectiveCompensationAsExpression
Link copied to clipboard

This is an Expression representation of "perspective-compensation".

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.

val perspectiveCompensationAsExpression: Expression?
shadowImage
Link copied to clipboard

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

val shadowImage: String?
shadowImageAsExpression
Link copied to clipboard

This is an Expression representation of "shadow-image".

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

val shadowImageAsExpression: Expression?
shadowImageSize
Link copied to clipboard

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

val shadowImageSize: Double?
shadowImageSizeAsExpression
Link copied to clipboard

This is an Expression representation of "shadow-image-size".

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

val shadowImageSizeAsExpression: Expression?
shadowImageSizeTransition
Link copied to clipboard

Transition options for ShadowImageSize.

val shadowImageSizeTransition: StyleTransition?
topImage
Link copied to clipboard

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

val topImage: String?
topImageAsExpression
Link copied to clipboard

This is an Expression representation of "top-image".

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

val topImageAsExpression: Expression?
topImageSize
Link copied to clipboard

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

val topImageSize: Double?
topImageSizeAsExpression
Link copied to clipboard

This is an Expression representation of "top-image-size".

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

val topImageSizeAsExpression: Expression?
topImageSizeTransition
Link copied to clipboard

Transition options for TopImageSize.

val topImageSizeTransition: StyleTransition?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?