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

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

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

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

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

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

The bearing of the location indicator. Values under 0.01 degree variation are ignored. Default value: 0.

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.

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

Link copied to clipboard

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

Link copied to clipboard

The bearing of the location indicator. Values under 0.01 degree variation are ignored. Default value: 0.

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

Link copied to clipboard

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

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

Specifies a glow effect range of the emphasis circle, in pixels. If 0,0 values are provided, it renders the circle as a solid color. The first value specifies the start of the glow effect where it is equal to the circle's color, the second is the end, where it's fully transparent. Between the two values the effect is linearly faded out. Default value: 0,0.

Link copied to clipboard

Specifies a glow effect range of the emphasis circle, in pixels. If 0,0 values are provided, it renders the circle as a solid color. The first value specifies the start of the glow effect where it is equal to the circle's color, the second is the end, where it's fully transparent. Between the two values the effect is linearly faded out. Default value: 0,0.

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

Link copied to clipboard

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

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

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. Values under 0.000001 variation are ignored. Default value: 0,0,0.

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

The opacity of the entire location indicator layer. Default value: 1. Value range: 0, 1

Link copied to clipboard

The opacity of the entire location indicator layer. Default value: 1. Value range: 0, 1

Link copied to clipboard

An array of latitude, longitude, altitude position of the location indicator. Values under 0.000001 variation are ignored. Default value: 0,0,0.

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.

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.

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

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.

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

Link copied to clipboard

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

Link copied to clipboard
abstract 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.

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.

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

Link copied to clipboard

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

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

Whether this layer is displayed.

Inheritors

Link copied to clipboard