LocationComponentSettingsInterface

interface LocationComponentSettingsInterface

Interface that defines the public settings interface for LocationComponentPlugin.

Functions

getSettings

abstract fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

updateSettings

abstract fun updateSettings(block: LocationComponentSettings.() -> Unit)

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

Properties

enabled

abstract var enabled: Boolean

Whether the user location is visible on the map.

layerAbove

abstract var layerAbove: String?

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

layerBelow

abstract var layerBelow: String?

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

locationPuck

abstract var locationPuck: LocationPuck

Defines what the customised look of the location puck. Note that direct changes to the puck variables won't have any effect, a new puck needs to be set every time.

pulsingColor

abstract var pulsingColor: Int

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

pulsingEnabled

abstract var pulsingEnabled: Boolean

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

pulsingMaxRadius

abstract 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

LocationComponentPlugin

LocationComponentSettingsBase

LocationComponentSettingsInterface2