LocationComponentSettingsBase

abstract class LocationComponentSettingsBase : LocationComponentSettingsInterface

Abstract settings class for LocationComponentPlugin.

This abstract class exposes all the required public APIs to configure the LocationComponentPlugin.

Constructors

LocationComponentSettingsBase
Link copied to clipboard
fun LocationComponentSettingsBase()

Functions

getSettings
Link copied to clipboard
open override fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

updateSettings
Link copied to clipboard
open override fun updateSettings(block: LocationComponentSettings.() -> Unit)

Update locationcomponent configuration, the update will be applied to the plugin automatically.

Properties

enabled
Link copied to clipboard
open override var enabled: Boolean

Whether the user location is visible on the map.

layerAbove
Link copied to clipboard
open override var layerAbove: String?

Sets the id of the layer that's added above to when placing the component on the map.

layerBelow
Link copied to clipboard
open override var layerBelow: String?

Sets the id of the layer that's added below to when placing the component on the map.

locationPuck
Link copied to clipboard
open override var locationPuck: LocationPuck

Defines what the customised look of the location puck.

pulsingColor
Link copied to clipboard
open override var pulsingColor: Int

The color of the pulsing circle. Works for 2D location puck only.

pulsingEnabled
Link copied to clipboard
open override var pulsingEnabled: Boolean

Whether the location puck is pulsing on the map. Works for 2D location puck only.

pulsingMaxRadius
Link copied to clipboard
open override var pulsingMaxRadius: Float

The maximum radius of the pulsing circle. Works for 2D location puck only. Note: Setting pulsingMaxRadius to LocationComponentConstants.PULSING_MAX_RADIUS_FOLLOW_ACCURACY will set the pulsing circle's maximum radius to follow location accuracy circle.

Inheritors

LocationComponentSettingsBase2
Link copied to clipboard