LocationComponentSettingsInterface

Interface that defines the public settings interface for LocationComponentPlugin.

interface LocationComponentSettingsInterface

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getSettings
Link copied to clipboard

Get current locationcomponent configuration.

abstract fun getSettings(): LocationComponentSettings
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String
updateSettings
Link copied to clipboard

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

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

Properties

enabled
Link copied to clipboard

Whether the user location is visible on the map.

abstract var enabled: Boolean
layerAbove
Link copied to clipboard

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

abstract var layerAbove: String?
layerBelow
Link copied to clipboard

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

abstract var layerBelow: String?
locationPuck
Link copied to clipboard

Defines what the customised look of the location puck.

abstract var locationPuck: LocationPuck
pulsingColor
Link copied to clipboard

The color of the pulsing circle. Only work for 2D location puck.

abstract var pulsingColor: Int
pulsingEnabled
Link copied to clipboard

Whether the location puck is pulsing on the map. Only work for 2D location puck.

abstract var pulsingEnabled: Boolean
pulsingMaxRadius
Link copied to clipboard

The maximum radius of the pulsing circle. Only work for 2D location puck.

abstract var pulsingMaxRadius: Float

Inheritors

LocationComponentPlugin
Link copied to clipboard
LocationComponentSettingsBase
Link copied to clipboard