Mapbox Maps Android/com.mapbox.maps.extension.style.layers.generated/LocationIndicatorLayer

LocationIndicatorLayer

Location Indicator layer.

@UiThread()

class LocationIndicatorLayer(layerId: String) : Layer, LocationIndicatorLayerDsl

Parameters

layerId

the ID of the layer

Constructors

LocationIndicatorLayer

the ID of the layer

fun LocationIndicatorLayer(layerId: String)

Types

Companion

Static variables and methods.

object Companion

Functions

accuracyRadius

Set the AccuracyRadius property

open override fun accuracyRadius(accuracyRadius: Expression): LocationIndicatorLayer

open override fun accuracyRadius(accuracyRadius: Double): LocationIndicatorLayer

accuracyRadiusBorderColor

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

Set the AccuracyRadiusBorderColor property transition options

open override fun accuracyRadiusBorderColorTransition(options: StyleTransition): LocationIndicatorLayer

DSL for accuracyRadiusBorderColorTransition.

open override fun accuracyRadiusBorderColorTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

accuracyRadiusColor

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

Set the AccuracyRadiusColor property transition options

open override fun accuracyRadiusColorTransition(options: StyleTransition): LocationIndicatorLayer

DSL for accuracyRadiusColorTransition.

open override fun accuracyRadiusColorTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

accuracyRadiusTransition

Set the AccuracyRadius property transition options

open override fun accuracyRadiusTransition(options: StyleTransition): LocationIndicatorLayer

DSL for accuracyRadiusTransition.

open override fun accuracyRadiusTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

bearing

Set the Bearing property

open override fun bearing(bearing: Expression): LocationIndicatorLayer

open override fun bearing(bearing: Double): LocationIndicatorLayer

bearingImage

Set the BearingImage property

open override fun bearingImage(bearingImage: Expression): LocationIndicatorLayer

open override fun bearingImage(bearingImage: String): LocationIndicatorLayer

bearingImageSize

Set the BearingImageSize property

open override fun bearingImageSize(bearingImageSize: Expression): LocationIndicatorLayer

open override fun bearingImageSize(bearingImageSize: Double): LocationIndicatorLayer

bearingImageSizeTransition

Set the BearingImageSize property transition options

open override fun bearingImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

DSL for bearingImageSizeTransition.

open override fun bearingImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

bindTo

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

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

Set the EmphasisCircleColor property transition options

open override fun emphasisCircleColorTransition(options: StyleTransition): LocationIndicatorLayer

DSL for emphasisCircleColorTransition.

open override fun emphasisCircleColorTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

emphasisCircleRadius

Set the EmphasisCircleRadius property

open override fun emphasisCircleRadius(emphasisCircleRadius: Expression): LocationIndicatorLayer

open override fun emphasisCircleRadius(emphasisCircleRadius: Double): LocationIndicatorLayer

emphasisCircleRadiusTransition

Set the EmphasisCircleRadius property transition options

open override fun emphasisCircleRadiusTransition(options: StyleTransition): LocationIndicatorLayer

DSL for emphasisCircleRadiusTransition.

open override fun emphasisCircleRadiusTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

equals

open operator override fun equals(other: Any?): Boolean

getCachedLayerProperties

override fun getCachedLayerProperties(): Value

hashCode

open override fun hashCode(): Int

imagePitchDisplacement

Set the ImagePitchDisplacement property

open override fun imagePitchDisplacement(imagePitchDisplacement: Expression): LocationIndicatorLayer

open override fun imagePitchDisplacement(imagePitchDisplacement: Double): LocationIndicatorLayer

location

Set the Location property

open override fun location(location: Expression): LocationIndicatorLayer

open override fun location(location: List<Double>): LocationIndicatorLayer

locationTransition

Set the Location property transition options

open override fun locationTransition(options: StyleTransition): LocationIndicatorLayer

DSL for locationTransition.

open override fun locationTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

maxZoom

Set the maxzoom property

open override fun maxZoom(maxZoom: Double): LocationIndicatorLayer

minZoom

Set the minzoom property

open override fun minZoom(minZoom: Double): LocationIndicatorLayer

perspectiveCompensation

Set the PerspectiveCompensation property

open override fun perspectiveCompensation(perspectiveCompensation: Expression): LocationIndicatorLayer

open override fun perspectiveCompensation(perspectiveCompensation: Double): LocationIndicatorLayer

shadowImage

Set the ShadowImage property

open override fun shadowImage(shadowImage: Expression): LocationIndicatorLayer

open override fun shadowImage(shadowImage: String): LocationIndicatorLayer

shadowImageSize

Set the ShadowImageSize property

open override fun shadowImageSize(shadowImageSize: Expression): LocationIndicatorLayer

open override fun shadowImageSize(shadowImageSize: Double): LocationIndicatorLayer

shadowImageSizeTransition

Set the ShadowImageSize property transition options

open override fun shadowImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

DSL for shadowImageSizeTransition.

open override fun shadowImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

topImage

Set the TopImage property

open override fun topImage(topImage: Expression): LocationIndicatorLayer

open override fun topImage(topImage: String): LocationIndicatorLayer

topImageSize

Set the TopImageSize property

open override fun topImageSize(topImageSize: Expression): LocationIndicatorLayer

open override fun topImageSize(topImageSize: Double): LocationIndicatorLayer

topImageSizeTransition

Set the TopImageSize property transition options

open override fun topImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

DSL for topImageSizeTransition.

open override fun topImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

toString

open override fun toString(): String

updateProperty

override fun updateProperty(property: PropertyValue<*>)

visibility

Set the Visibility property

open override fun visibility(visibility: Visibility): LocationIndicatorLayer

Properties

accuracyRadius

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

val accuracyRadius: Double?

accuracyRadiusAsExpression

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

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

val accuracyRadiusBorderColor: String?

accuracyRadiusBorderColorAsColorInt

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

val accuracyRadiusBorderColorAsColorInt: Int?

accuracyRadiusBorderColorAsExpression

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

Transition options for AccuracyRadiusBorderColor.

val accuracyRadiusBorderColorTransition: StyleTransition?

accuracyRadiusColor

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

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

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

Transition options for AccuracyRadiusColor.

val accuracyRadiusColorTransition: StyleTransition?

accuracyRadiusTransition

Transition options for AccuracyRadius.

val accuracyRadiusTransition: StyleTransition?

bearing

The bearing of the location indicator.

val bearing: Double?

bearingAsExpression

This is an Expression representation of "bearing".

The bearing of the location indicator.

val bearingAsExpression: Expression?

bearingImage

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

val bearingImage: String?

bearingImageAsExpression

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

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

val bearingImageSize: Double?

bearingImageSizeAsExpression

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

Transition options for BearingImageSize.

val bearingImageSizeTransition: StyleTransition?

emphasisCircleColor

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

val emphasisCircleColor: String?

emphasisCircleColorAsColorInt

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

val emphasisCircleColorAsColorInt: Int?

emphasisCircleColorAsExpression

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

Transition options for EmphasisCircleColor.

val emphasisCircleColorTransition: StyleTransition?

emphasisCircleRadius

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

val emphasisCircleRadius: Double?

emphasisCircleRadiusAsExpression

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

Transition options for EmphasisCircleRadius.

val emphasisCircleRadiusTransition: StyleTransition?

imagePitchDisplacement

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

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

the ID of the layer

open override val layerId: String

layerProperties

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>

location

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

val location: List<Double>?

locationAsExpression

This is an Expression representation of "location".

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

val locationAsExpression: Expression?

locationTransition

Transition options for Location.

val locationTransition: StyleTransition?

maxZoom

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

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

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

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

val perspectiveCompensationAsExpression: Expression?

shadowImage

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

val shadowImage: String?

shadowImageAsExpression

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