LocationComponentSettingsInterface

interface LocationComponentSettingsInterface
Content copied to clipboard

Interface that defines the public settings interface for LocationComponentPlugin.

Functions

getSettings
Link copied to clipboard
abstract fun getSettings(): LocationComponentSettings
Content copied to clipboard
Get current locationcomponent configuration.
updateSettings
Link copied to clipboard
abstract fun updateSettings(block: LocationComponentSettings.() -> Unit)
Content copied to clipboard
Update locationcomponent configuration, the update will be applied to the plugin automatically.

Properties

enabled
Link copied to clipboard
abstract var enabled: Boolean
Content copied to clipboard
Whether the user location is visible on the map.
layerAbove
Link copied to clipboard
abstract var layerAbove: String?
Content copied to clipboard
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?
Content copied to clipboard
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
Content copied to clipboard
Defines what the customised look of the location puck.
pulsingColor
Link copied to clipboard
abstract var pulsingColor: Int
Content copied to clipboard
The color of the pulsing circle.
pulsingEnabled
Link copied to clipboard
abstract var pulsingEnabled: Boolean
Content copied to clipboard
Whether the location puck is pulsing on the map.
pulsingMaxRadius
Link copied to clipboard
abstract var pulsingMaxRadius: Float
Content copied to clipboard
The maximum radius of the pulsing circle.

Inheritors

LocationComponentPlugin
Link copied to clipboard
LocationComponentSettingsBase
Link copied to clipboard