mapbox-maps-android/com.mapbox.maps.plugin.locationcomponent.generated/LocationComponentSettingsInterface

LocationComponentSettingsInterface

interface LocationComponentSettingsInterface

Interface that defines the public settings interface for LocationComponentPlugin.

Functions

equals

androidJvm

open operator fun equals(other: Any?): Boolean

getSettings

androidJvm

abstract fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String

updateSettings

androidJvm

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

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

Properties

enabled

androidJvm

abstract var enabled: Boolean

Whether the user location is visible on the map.

layerAbove

androidJvm

abstract var layerAbove: String?

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

layerBelow

androidJvm

abstract var layerBelow: String?

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

locationPuck

androidJvm

abstract var locationPuck: LocationPuck

Defines what the customised look of the location puck.

pulsingColor

androidJvm

abstract var pulsingColor: Int

The color of the pulsing circle.

pulsingEnabled

androidJvm

abstract var pulsingEnabled: Boolean

Whether the location puck is pulsing on the map.

pulsingMaxRadius

androidJvm

abstract var pulsingMaxRadius: Float

The maximum radius of the pulsing circle.

Inheritors

LocationComponentPlugin

LocationComponentSettingsBase

LocationComponentSettingsInterface2