mapbox-maps-android/com.mapbox.maps.extension.style.layers.generated/LocationIndicatorLayer

LocationIndicatorLayer

@UiThread

class LocationIndicatorLayer(val layerId: String) : Layer, LocationIndicatorLayerDsl

Location Indicator layer.

Parameters

layerId

the ID of the layer

Constructors

LocationIndicatorLayer

fun LocationIndicatorLayer(layerId: String)

Types

Companion

object Companion

Static variables and methods.

Functions

accuracyRadius

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.

accuracyRadiusBorderColor

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

accuracyRadiusBorderColorTransition

open override fun accuracyRadiusBorderColorTransition(options: StyleTransition): LocationIndicatorLayer

Set the AccuracyRadiusBorderColor property transition options

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

DSL for accuracyRadiusBorderColorTransition.

accuracyRadiusColor

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

accuracyRadiusColorTransition

open override fun accuracyRadiusColorTransition(options: StyleTransition): LocationIndicatorLayer

Set the AccuracyRadiusColor property transition options

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

DSL for accuracyRadiusColorTransition.

accuracyRadiusTransition

open override fun accuracyRadiusTransition(options: StyleTransition): LocationIndicatorLayer

Set the AccuracyRadius property transition options

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

DSL for accuracyRadiusTransition.

bearing

open override fun bearing(bearing: Expression): LocationIndicatorLayer

open override fun bearing(bearing: Double): LocationIndicatorLayer

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

bearingImage

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

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.

bearingImageSizeTransition

open override fun bearingImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

Set the BearingImageSize property transition options

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

DSL for bearingImageSizeTransition.

bearingTransition

open override fun bearingTransition(options: StyleTransition): LocationIndicatorLayer

Set the Bearing property transition options

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

DSL for bearingTransition.

bindTo

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.

emphasisCircleColor

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

emphasisCircleColorTransition

open override fun emphasisCircleColorTransition(options: StyleTransition): LocationIndicatorLayer

Set the EmphasisCircleColor property transition options

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

DSL for emphasisCircleColorTransition.

emphasisCircleRadius

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.

emphasisCircleRadiusTransition

open override fun emphasisCircleRadiusTransition(options: StyleTransition): LocationIndicatorLayer

Set the EmphasisCircleRadius property transition options

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

DSL for emphasisCircleRadiusTransition.

imagePitchDisplacement

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

location

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.

locationIndicatorOpacity

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

locationIndicatorOpacityTransition

open override fun locationIndicatorOpacityTransition(options: StyleTransition): LocationIndicatorLayer

Set the LocationIndicatorOpacity property transition options

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

DSL for locationIndicatorOpacityTransition.

locationTransition

open override fun locationTransition(options: StyleTransition): LocationIndicatorLayer

Set the Location property transition options

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

DSL for locationTransition.

maxZoom

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

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

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

shadowImage

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

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.

shadowImageSizeTransition

open override fun shadowImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

Set the ShadowImageSize property transition options

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

DSL for shadowImageSizeTransition.

slot

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.

topImage

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

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.

topImageSizeTransition

open override fun topImageSizeTransition(options: StyleTransition): LocationIndicatorLayer

Set the TopImageSize property transition options

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

DSL for topImageSizeTransition.

visibility

open override fun visibility(visibility: Expression): LocationIndicatorLayer

open override fun visibility(visibility: Visibility): LocationIndicatorLayer

Whether this layer is displayed.

Properties

accuracyRadius

val accuracyRadius: Double?

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

accuracyRadiusAsExpression

val accuracyRadiusAsExpression: Expression?

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

accuracyRadiusBorderColor

val accuracyRadiusBorderColor: String?

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

accuracyRadiusBorderColorAsColorInt

@get:ColorInt

val accuracyRadiusBorderColorAsColorInt: Int?

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

accuracyRadiusBorderColorAsExpression

val accuracyRadiusBorderColorAsExpression: Expression?

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

accuracyRadiusBorderColorTransition

val accuracyRadiusBorderColorTransition: StyleTransition?

Transition options for AccuracyRadiusBorderColor.

accuracyRadiusColor

val accuracyRadiusColor: String?

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

accuracyRadiusColorAsColorInt

@get:ColorInt

val accuracyRadiusColorAsColorInt: Int?

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

accuracyRadiusColorAsExpression

val accuracyRadiusColorAsExpression: Expression?

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

accuracyRadiusColorTransition

val accuracyRadiusColorTransition: StyleTransition?

Transition options for AccuracyRadiusColor.

accuracyRadiusTransition

val accuracyRadiusTransition: StyleTransition?

Transition options for AccuracyRadius.

bearing

val bearing: Double?

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

bearingAsExpression

val bearingAsExpression: Expression?

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

bearingImage

val bearingImage: String?

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

bearingImageAsExpression

val bearingImageAsExpression: Expression?

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

bearingImageSize

val bearingImageSize: Double?

The size of the bearing image, as a scale factor applied to the size of the specified image. Default value: 1.

bearingImageSizeAsExpression

val bearingImageSizeAsExpression: Expression?

The size of the bearing image, as a scale factor applied to the size of the specified image. Default value: 1.

bearingImageSizeTransition

val bearingImageSizeTransition: StyleTransition?

Transition options for BearingImageSize.

bearingTransition

val bearingTransition: StyleTransition?

Transition options for Bearing.

emphasisCircleColor

val emphasisCircleColor: String?

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

emphasisCircleColorAsColorInt

@get:ColorInt

val emphasisCircleColorAsColorInt: Int?

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

emphasisCircleColorAsExpression

val emphasisCircleColorAsExpression: Expression?

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly. Default value: "#ffffff".

emphasisCircleColorTransition

val emphasisCircleColorTransition: StyleTransition?

Transition options for EmphasisCircleColor.

emphasisCircleRadius

val emphasisCircleRadius: Double?

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

emphasisCircleRadiusAsExpression

val emphasisCircleRadiusAsExpression: Expression?

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

emphasisCircleRadiusTransition

val emphasisCircleRadiusTransition: StyleTransition?

Transition options for EmphasisCircleRadius.

imagePitchDisplacement

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. Default value: "0".

imagePitchDisplacementAsExpression

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. Default value: "0".

layerId

open override val layerId: String

location