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)
the ID of the layer

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
Set the AccuracyRadius property
open override fun accuracyRadius(accuracyRadius: Double): LocationIndicatorLayer
Set the AccuracyRadius property
accuracyRadiusBorderColor
Link copied to clipboard
open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: Expression): LocationIndicatorLayer
Set the AccuracyRadiusBorderColor property
open override fun accuracyRadiusBorderColor(@ColorInt() accuracyRadiusBorderColor: Int): LocationIndicatorLayer
Set the AccuracyRadiusBorderColor property.
open override fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: String): LocationIndicatorLayer
Set the AccuracyRadiusBorderColor property
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
Set the AccuracyRadiusColor property
open override fun accuracyRadiusColor(@ColorInt() accuracyRadiusColor: Int): LocationIndicatorLayer
Set the AccuracyRadiusColor property.
open override fun accuracyRadiusColor(accuracyRadiusColor: String): LocationIndicatorLayer
Set the AccuracyRadiusColor property
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
Set the Bearing property
open override fun bearing(bearing: Double): LocationIndicatorLayer
Set the Bearing property
bearingImage
Link copied to clipboard
open override fun bearingImage(bearingImage: Expression): LocationIndicatorLayer
Set the BearingImage property
open override fun bearingImage(bearingImage: String): LocationIndicatorLayer
Set the BearingImage property
bearingImageSize
Link copied to clipboard
open override fun bearingImageSize(bearingImageSize: Expression): LocationIndicatorLayer
Set the BearingImageSize property
open override fun bearingImageSize(bearingImageSize: Double): LocationIndicatorLayer
Set the BearingImageSize property
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
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
Set the EmphasisCircleColor property
open override fun emphasisCircleColor(@ColorInt() emphasisCircleColor: Int): LocationIndicatorLayer
Set the EmphasisCircleColor property.
open override fun emphasisCircleColor(emphasisCircleColor: String): LocationIndicatorLayer
Set the EmphasisCircleColor property
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
Set the EmphasisCircleRadius property
open override fun emphasisCircleRadius(emphasisCircleRadius: Double): LocationIndicatorLayer
Set the EmphasisCircleRadius property
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
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open fun hashCode(): Int
imagePitchDisplacement
Link copied to clipboard
open override fun imagePitchDisplacement(imagePitchDisplacement: Expression): LocationIndicatorLayer
Set the ImagePitchDisplacement property
open override fun imagePitchDisplacement(imagePitchDisplacement: Double): LocationIndicatorLayer
Set the ImagePitchDisplacement property
location
Link copied to clipboard
open override fun location(location: Expression): LocationIndicatorLayer
Set the Location property
open override fun location(location: List<Double>): LocationIndicatorLayer
Set the Location property
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
Set the maxzoom property
minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): LocationIndicatorLayer
Set the minzoom property
perspectiveCompensation
Link copied to clipboard
open override fun perspectiveCompensation(perspectiveCompensation: Expression): LocationIndicatorLayer
Set the PerspectiveCompensation property
open override fun perspectiveCompensation(perspectiveCompensation: Double): LocationIndicatorLayer
Set the PerspectiveCompensation property
shadowImage
Link copied to clipboard
open override fun shadowImage(shadowImage: Expression): LocationIndicatorLayer
Set the ShadowImage property
open override fun shadowImage(shadowImage: String): LocationIndicatorLayer
Set the ShadowImage property
shadowImageSize
Link copied to clipboard
open override fun shadowImageSize(shadowImageSize: Expression): LocationIndicatorLayer
Set the ShadowImageSize property
open override fun shadowImageSize(shadowImageSize: Double): LocationIndicatorLayer
Set the ShadowImageSize property
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
Set the TopImage property
open override fun topImage(topImage: String): LocationIndicatorLayer
Set the TopImage property
topImageSize
Link copied to clipboard
open override fun topImageSize(topImageSize: Expression): LocationIndicatorLayer
Set the TopImageSize property
open override fun topImageSize(topImageSize: Double): LocationIndicatorLayer
Set the TopImageSize property
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
toString
Link copied to clipboard
open fun toString(): String
visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): LocationIndicatorLayer
Set the Visibility property

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?
This is an Expression representation of "accuracy-radius".
accuracyRadiusBorderColor
Link copied to clipboard
val accuracyRadiusBorderColor: String?
The color for drawing the accuracy radius border.
accuracyRadiusBorderColorAsColorInt
Link copied to clipboard
val accuracyRadiusBorderColorAsColorInt: Int?
The color for drawing the accuracy radius border.
accuracyRadiusBorderColorAsExpression
Link copied to clipboard
val accuracyRadiusBorderColorAsExpression: Expression?
This is an Expression representation of "accuracy-radius-border-color".
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.
accuracyRadiusColorAsColorInt
Link copied to clipboard
val accuracyRadiusColorAsColorInt: Int?
The color for drawing the accuracy radius, as a circle.
accuracyRadiusColorAsExpression
Link copied to clipboard
val accuracyRadiusColorAsExpression: Expression?
This is an Expression representation of "accuracy-radius-color".
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?
This is an Expression representation of "bearing".
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?
This is an Expression representation of "bearing-image".
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?
This is an Expression representation of "bearing-image-size".
bearingImageSizeTransition
Link copied to clipboard
val bearingImageSizeTransition: StyleTransition?
Transition options for BearingImageSize.
emphasisCircleColor
Link copied to clipboard
val emphasisCircleColor: String?
The color of the circle emphasizing the indicator.
emphasisCircleColorAsColorInt
Link copied to clipboard
val emphasisCircleColorAsColorInt: Int?
The color of the circle emphasizing the indicator.
emphasisCircleColorAsExpression
Link copied to clipboard
val emphasisCircleColorAsExpression: Expression?
This is an Expression representation of "emphasis-circle-color".
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?
This is an Expression representation of "emphasis-circle-radius".
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.
imagePitchDisplacementAsExpression
Link copied to clipboard
val imagePitchDisplacementAsExpression: Expression?
This is an Expression representation of "image-pitch-displacement".
layerId
Link copied to clipboard
open override val layerId: String
the ID of the layer
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?
This is an Expression representation of "location".
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.
minZoom
Link copied to clipboard
open override val minZoom: Double?
The minimum zoom level for the layer.
perspectiveCompensation
Link copied to clipboard
val perspectiveCompensation: Double?
The amount of the perspective compensation, between 0 and 1.
perspectiveCompensationAsExpression
Link copied to clipboard
val perspectiveCompensationAsExpression: Expression?
This is an Expression representation of "perspective-compensation".
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?
This is an Expression representation of "shadow-image".
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?
This is an Expression representation of "shadow-image-size".
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?
This is an Expression representation of "top-image".
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?
This is an Expression representation of "top-image-size".
topImageSizeTransition
Link copied to clipboard
val topImageSizeTransition: StyleTransition?
Transition options for TopImageSize.
visibility
Link copied to clipboard
open override val visibility: Visibility?
Visibility of the layer.