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

LocationIndicatorLayer

@UiThread()

class LocationIndicatorLayer(layerId: String) : Layer, LocationIndicatorLayerDsl

Location Indicator layer.

Parameters

layerId

the ID of the layer

Constructors

LocationIndicatorLayer

androidJvm

fun LocationIndicatorLayer(layerId: String)

the ID of the layer

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

accuracyRadius

androidJvm

open override fun accuracyRadius(accuracyRadius: Expression): LocationIndicatorLayer

Set the AccuracyRadius property

open override fun accuracyRadius(accuracyRadius: Double): LocationIndicatorLayer

Set the AccuracyRadius property

accuracyRadiusBorderColor

androidJvm

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

androidJvm

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

androidJvm

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

androidJvm

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

androidJvm

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

androidJvm

open override fun bearing(bearing: Expression): LocationIndicatorLayer

Set the Bearing property

open override fun bearing(bearing: Double): LocationIndicatorLayer

Set the Bearing property

bearingImage

androidJvm

open override fun bearingImage(bearingImage: Expression): LocationIndicatorLayer

Set the BearingImage property

open override fun bearingImage(bearingImage: String): LocationIndicatorLayer

Set the BearingImage property

bearingImageSize

androidJvm

open override fun bearingImageSize(bearingImageSize: Expression): LocationIndicatorLayer

Set the BearingImageSize property

open override fun bearingImageSize(bearingImageSize: Double): LocationIndicatorLayer

Set the BearingImageSize property

bearingImageSizeTransition

androidJvm

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

androidJvm

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

androidJvm

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

androidJvm

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

androidJvm

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

androidJvm

open override fun emphasisCircleRadius(emphasisCircleRadius: Expression): LocationIndicatorLayer

Set the EmphasisCircleRadius property

open override fun emphasisCircleRadius(emphasisCircleRadius: Double): LocationIndicatorLayer

Set the EmphasisCircleRadius property

emphasisCircleRadiusTransition

androidJvm

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.

equals

androidJvm

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

hashCode

androidJvm

open fun hashCode(): Int

imagePitchDisplacement

androidJvm

open override fun imagePitchDisplacement(imagePitchDisplacement: Expression): LocationIndicatorLayer

Set the ImagePitchDisplacement property

open override fun imagePitchDisplacement(imagePitchDisplacement: Double): LocationIndicatorLayer

Set the ImagePitchDisplacement property

location

androidJvm

open override fun location(location: Expression): LocationIndicatorLayer

Set the Location property

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

Set the Location property

locationTransition

androidJvm

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

androidJvm

open override fun maxZoom(maxZoom: Double): LocationIndicatorLayer

Set the maxzoom property

minZoom

androidJvm

open override fun minZoom(minZoom: Double): LocationIndicatorLayer

Set the minzoom property

perspectiveCompensation

androidJvm

open override fun perspectiveCompensation(perspectiveCompensation: Expression): LocationIndicatorLayer

Set the PerspectiveCompensation property

open override fun perspectiveCompensation(perspectiveCompensation: Double): LocationIndicatorLayer

Set the PerspectiveCompensation property

shadowImage

androidJvm

open override fun shadowImage(shadowImage: Expression): LocationIndicatorLayer

Set the ShadowImage property

open override fun shadowImage(shadowImage: String): LocationIndicatorLayer

Set the ShadowImage property

shadowImageSize

androidJvm

open override fun shadowImageSize(shadowImageSize: Expression): LocationIndicatorLayer

Set the ShadowImageSize property

open override fun shadowImageSize(shadowImageSize: Double): LocationIndicatorLayer

Set the ShadowImageSize property

shadowImageSizeTransition

androidJvm

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.

topImage

androidJvm

open override fun topImage(topImage: Expression): LocationIndicatorLayer

Set the TopImage property

open override fun topImage(topImage: String): LocationIndicatorLayer

Set the TopImage property

topImageSize

androidJvm

open override fun topImageSize(topImageSize: Expression): LocationIndicatorLayer

Set the TopImageSize property

open override fun topImageSize(topImageSize: Double): LocationIndicatorLayer

Set the TopImageSize property

topImageSizeTransition

androidJvm

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.

toString

androidJvm

open fun toString(): String

visibility

androidJvm

open override fun visibility(visibility: Visibility): LocationIndicatorLayer

Set the Visibility property

Properties

accuracyRadius

androidJvm

val accuracyRadius: Double?

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

accuracyRadiusAsExpression

androidJvm

val accuracyRadiusAsExpression: Expression?

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

accuracyRadiusBorderColor

androidJvm

val accuracyRadiusBorderColor: String?

The color for drawing the accuracy radius border.

accuracyRadiusBorderColorAsColorInt

androidJvm

val accuracyRadiusBorderColorAsColorInt: Int?

The color for drawing the accuracy radius border.

accuracyRadiusBorderColorAsExpression

androidJvm

val accuracyRadiusBorderColorAsExpression: Expression?

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

accuracyRadiusBorderColorTransition

androidJvm

val accuracyRadiusBorderColorTransition: StyleTransition?

Transition options for AccuracyRadiusBorderColor.

accuracyRadiusColor

androidJvm

val accuracyRadiusColor: String?

The color for drawing the accuracy radius, as a circle.

accuracyRadiusColorAsColorInt

androidJvm

val accuracyRadiusColorAsColorInt: Int?

The color for drawing the accuracy radius, as a circle.

accuracyRadiusColorAsExpression

androidJvm

val accuracyRadiusColorAsExpression: Expression?

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

accuracyRadiusColorTransition

androidJvm

val accuracyRadiusColorTransition: StyleTransition?

Transition options for AccuracyRadiusColor.

accuracyRadiusTransition

androidJvm

val accuracyRadiusTransition: StyleTransition?

Transition options for AccuracyRadius.

bearing

androidJvm

val bearing: Double?

The bearing of the location indicator.

bearingAsExpression

androidJvm

val bearingAsExpression: Expression?

This is an Expression representation of "bearing".

bearingImage

androidJvm

val bearingImage: String?

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

bearingImageAsExpression

androidJvm

val bearingImageAsExpression: Expression?

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

bearingImageSize

androidJvm

val bearingImageSize: Double?

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

bearingImageSizeAsExpression

androidJvm

val bearingImageSizeAsExpression: Expression?

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

bearingImageSizeTransition

androidJvm

val bearingImageSizeTransition: StyleTransition?

Transition options for BearingImageSize.

bearingTransition

androidJvm

val bearingTransition: StyleTransition?

Transition options for Bearing.

emphasisCircleColor

androidJvm

val emphasisCircleColor: String?

The color of the circle emphasizing the indicator.

emphasisCircleColorAsColorInt

androidJvm

val emphasisCircleColorAsColorInt: Int?

The color of the circle emphasizing the indicator.

emphasisCircleColorAsExpression

androidJvm

val emphasisCircleColorAsExpression: Expression?

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

emphasisCircleColorTransition

androidJvm

val emphasisCircleColorTransition: StyleTransition?

Transition options for EmphasisCircleColor.

emphasisCircleRadius

androidJvm

val emphasisCircleRadius: Double?

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

emphasisCircleRadiusAsExpression

androidJvm

val emphasisCircleRadiusAsExpression: Expression?

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

emphasisCircleRadiusTransition

androidJvm

val emphasisCircleRadiusTransition: StyleTransition?

Transition options for EmphasisCircleRadius.

imagePitchDisplacement

androidJvm

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

androidJvm

val imagePitchDisplacementAsExpression: Expression?

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

layerId

androidJvm

open override val layerId: String

the ID of the layer

location

androidJvm

val location: List<Double>?

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

locationAsExpression

androidJvm

val locationAsExpression: Expression?

This is an Expression representation of "location".

locationTransition

androidJvm

val locationTransition: StyleTransition?

Transition options for Location.

maxZoom

androidJvm

open override val maxZoom: Double?

The maximum zoom level for the layer.

minZoom

androidJvm

open override val minZoom: Double?

The minimum zoom level for the layer.

perspectiveCompensation

androidJvm

val perspectiveCompensation: Double?

The amount of the perspective compensation, between 0 and 1.

perspectiveCompensationAsExpression

androidJvm

val perspectiveCompensationAsExpression: Expression?

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

shadowImage

androidJvm

val shadowImage: String?

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

shadowImageAsExpression

androidJvm

val shadowImageAsExpression: Expression?

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

shadowImageSize

androidJvm

val shadowImageSize: Double?

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

shadowImageSizeAsExpression

androidJvm

val shadowImageSizeAsExpression: Expression?

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

shadowImageSizeTransition

androidJvm

val shadowImageSizeTransition: StyleTransition?

Transition options for ShadowImageSize.

topImage

androidJvm

val topImage: String?

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

topImageAsExpression

androidJvm

val topImageAsExpression: Expression?

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

topImageSize

androidJvm

val topImageSize: Double?

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

topImageSizeAsExpression

androidJvm

val topImageSizeAsExpression: Expression?

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

topImageSizeTransition

androidJvm

val topImageSizeTransition: StyleTransition?

Transition options for TopImageSize.

visibility

androidJvm

open override val visibility: Visibility?

Visibility of the layer.

LocationIndicatorLayer

See also

Parameters

Constructors

Types

Functions

Properties