LocationIndicatorLayerDsl

interface LocationIndicatorLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

accuracyRadius
Link copied to clipboard
abstract fun accuracyRadius(accuracyRadius: Expression): LocationIndicatorLayer
abstract fun accuracyRadius(accuracyRadius: Double = 0.0): LocationIndicatorLayer

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

accuracyRadiusBorderColor
Link copied to clipboard
abstract fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: Expression): LocationIndicatorLayer
abstract fun accuracyRadiusBorderColor(@ColorInt accuracyRadiusBorderColor: Int): LocationIndicatorLayer
abstract fun accuracyRadiusBorderColor(accuracyRadiusBorderColor: String = "#ffffff"): LocationIndicatorLayer

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

accuracyRadiusBorderColorTransition
Link copied to clipboard
abstract fun accuracyRadiusBorderColorTransition(options: StyleTransition): LocationIndicatorLayer
abstract fun accuracyRadiusBorderColorTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

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

accuracyRadiusColor
Link copied to clipboard
abstract fun accuracyRadiusColor(accuracyRadiusColor: Expression): LocationIndicatorLayer
abstract fun accuracyRadiusColor(@ColorInt accuracyRadiusColor: Int): LocationIndicatorLayer
abstract fun accuracyRadiusColor(accuracyRadiusColor: String = "#ffffff"): LocationIndicatorLayer

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

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

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

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

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

bearing
Link copied to clipboard
abstract fun bearing(bearing: Expression): LocationIndicatorLayer
abstract fun bearing(bearing: Double = 0.0): LocationIndicatorLayer

The bearing of the location indicator.

bearingImage
Link copied to clipboard
abstract fun bearingImage(bearingImage: Expression): LocationIndicatorLayer
abstract fun bearingImage(bearingImage: String): LocationIndicatorLayer

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

bearingImageSize
Link copied to clipboard
abstract fun bearingImageSize(bearingImageSize: Expression): LocationIndicatorLayer
abstract fun bearingImageSize(bearingImageSize: Double = 1.0): LocationIndicatorLayer

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

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

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

bearingTransition
Link copied to clipboard
abstract fun bearingTransition(options: StyleTransition): LocationIndicatorLayer
abstract fun bearingTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

The bearing of the location indicator.

emphasisCircleColor
Link copied to clipboard
abstract fun emphasisCircleColor(emphasisCircleColor: Expression): LocationIndicatorLayer
abstract fun emphasisCircleColor(@ColorInt emphasisCircleColor: Int): LocationIndicatorLayer
abstract fun emphasisCircleColor(emphasisCircleColor: String = "#ffffff"): LocationIndicatorLayer

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

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

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

emphasisCircleRadius
Link copied to clipboard
abstract fun emphasisCircleRadius(emphasisCircleRadius: Expression): LocationIndicatorLayer
abstract fun emphasisCircleRadius(emphasisCircleRadius: Double = 0.0): LocationIndicatorLayer

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

emphasisCircleRadiusTransition
Link copied to clipboard
abstract fun emphasisCircleRadiusTransition(options: StyleTransition): LocationIndicatorLayer
abstract fun emphasisCircleRadiusTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

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

imagePitchDisplacement
Link copied to clipboard
abstract fun imagePitchDisplacement(imagePitchDisplacement: Expression): LocationIndicatorLayer
abstract fun imagePitchDisplacement(imagePitchDisplacement: Double = 0.0): 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.

location
Link copied to clipboard
abstract fun location(location: Expression): LocationIndicatorLayer
abstract fun location(location: List<Double> = listOf(0.0, 0.0, 0.0)): LocationIndicatorLayer

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

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

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

maxZoom
Link copied to clipboard
abstract 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
Link copied to clipboard
abstract 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
Link copied to clipboard
abstract fun perspectiveCompensation(perspectiveCompensation: Expression): LocationIndicatorLayer
abstract fun perspectiveCompensation(perspectiveCompensation: Double = 0.85): 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.

shadowImage
Link copied to clipboard
abstract fun shadowImage(shadowImage: Expression): LocationIndicatorLayer
abstract fun shadowImage(shadowImage: String): LocationIndicatorLayer

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

shadowImageSize
Link copied to clipboard
abstract fun shadowImageSize(shadowImageSize: Expression): LocationIndicatorLayer
abstract fun shadowImageSize(shadowImageSize: Double = 1.0): LocationIndicatorLayer

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

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

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

topImage
Link copied to clipboard
abstract fun topImage(topImage: Expression): LocationIndicatorLayer
abstract fun topImage(topImage: String): LocationIndicatorLayer

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

topImageSize
Link copied to clipboard
abstract fun topImageSize(topImageSize: Expression): LocationIndicatorLayer
abstract fun topImageSize(topImageSize: Double = 1.0): LocationIndicatorLayer

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

topImageSizeTransition
Link copied to clipboard
abstract fun topImageSizeTransition(options: StyleTransition): LocationIndicatorLayer
abstract fun topImageSizeTransition(block: StyleTransition.Builder.() -> Unit): LocationIndicatorLayer

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

visibility
Link copied to clipboard
abstract fun visibility(visibility: Visibility): LocationIndicatorLayer

Whether this layer is displayed.

Inheritors

LocationIndicatorLayer
Link copied to clipboard