LocationComponentSettingsInterface2

Interface that defines the public settings interface for LocationComponentPlugin.

Functions

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

Get current locationcomponent configuration.

getSettings2
Link copied to clipboard
abstract fun getSettings2(): LocationComponentSettings2

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.

updateSettings2
Link copied to clipboard
abstract fun updateSettings2(block: LocationComponentSettings2.() -> Unit)

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

Properties

accuracyRingBorderColor
Link copied to clipboard
abstract var accuracyRingBorderColor: Int

The color of the accuracy ring border. Works for 2D location puck only.

accuracyRingColor
Link copied to clipboard
abstract var accuracyRingColor: Int

The color of the accuracy ring. Works for 2D location puck only.

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. Note that direct changes to the puck variables won't have any effect, a new puck needs to be set every time.

puckBearingEnabled
Link copied to clipboard
abstract var puckBearingEnabled: Boolean

Whether the puck rotates to track the bearing source.

puckBearingSource
Link copied to clipboard
abstract var puckBearingSource: PuckBearingSource

The enum controls how the puck is oriented

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. Note: Setting pulsingMaxRadius to LocationComponentConstants.PULSING_MAX_RADIUS_FOLLOW_ACCURACY will set the pulsing circle's maximum radius to follow location accuracy circle.

showAccuracyRing
Link copied to clipboard
abstract var showAccuracyRing: Boolean

Whether show accuracy ring with location puck. Works for 2D location puck only.

Inheritors

LocationComponentPlugin2
Link copied to clipboard
LocationComponentSettingsBase2
Link copied to clipboard