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

equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
getSettings
Link copied to clipboard
open override fun getSettings(): LocationComponentSettings
Get current locationcomponent configuration.
hashCode
Link copied to clipboard
open fun hashCode(): Int
toString
Link copied to clipboard
open fun toString(): String
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.
pulsingEnabled
Link copied to clipboard
open override var pulsingEnabled: Boolean
Whether the location puck is pulsing on the map.
pulsingMaxRadius
Link copied to clipboard
open override var pulsingMaxRadius: Float
The maximum radius of the pulsing circle.

Inheritors

LocationComponentPluginImpl
Link copied to clipboard