LocationComponentSettingsInterface

interface LocationComponentSettingsInterface

Interface that defines the public settings interface for LocationComponentPlugin.

Functions

getSettings
Link copied to clipboard
abstract fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

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

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

Properties

enabled
Link copied to clipboard
abstract var enabled: Boolean

Whether the user location is visible on the map.

layerAbove
Link copied to clipboard
abstract 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
abstract 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
abstract var locationPuck: LocationPuck

Defines what the customised look of the location puck.

pulsingColor
Link copied to clipboard
abstract var pulsingColor: Int

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

pulsingEnabled
Link copied to clipboard
abstract var pulsingEnabled: Boolean

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

pulsingMaxRadius
Link copied to clipboard
abstract var pulsingMaxRadius: Float

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

Inheritors

LocationComponentPlugin
Link copied to clipboard
LocationComponentSettingsBase
Link copied to clipboard
LocationComponentSettingsInterface2
Link copied to clipboard