LocationComponentSettingsBase

Abstract settings class for LocationComponentPlugin.

This abstract class exposes all the required public APIs to configure the LocationComponentPlugin.

abstract class LocationComponentSettingsBase : LocationComponentSettingsInterface

Constructors

LocationComponentSettingsBase
Link copied to clipboard
fun LocationComponentSettingsBase()

Functions

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

Get current locationcomponent configuration.

open override 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.

open override fun updateSettings(block: LocationComponentSettings.() -> Unit)

Properties

enabled
Link copied to clipboard

Whether the user location is visible on the map.

open override 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.

open override 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.

open override var layerBelow: String?
locationPuck
Link copied to clipboard

Defines what the customised look of the location puck.

open override var locationPuck: LocationPuck
pulsingColor
Link copied to clipboard

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

open override var pulsingColor: Int
pulsingEnabled
Link copied to clipboard

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

open override var pulsingEnabled: Boolean
pulsingMaxRadius
Link copied to clipboard

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

open override var pulsingMaxRadius: Float

Inheritors

LocationComponentPluginImpl
Link copied to clipboard