Mapbox Maps Android/com.mapbox.maps.plugin.locationcomponent/LocationComponentPlugin

LocationComponentPlugin

Define the interfaces for the Location plugin.

interface LocationComponentPlugin : MapPlugin, MapStyleObserverPlugin, LifecyclePlugin, ContextBinder, LocationComponentSettingsInterface

Functions

bind

Bind the ViewPlugin with current map context. This will create a View that will be added to the MapView.

abstract override fun bind(context: Context, attrs: AttributeSet?, pixelRatio: Float)

cleanup

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

open override fun cleanup()

equals

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

getLocationProvider

Get the current LocationProvider under usage with the LocationComponentPlugin.

abstract fun getLocationProvider(): LocationProvider?

getSettings

Get current locationcomponent configuration.

abstract override fun getSettings(): LocationComponentSettings

hashCode

open override fun hashCode(): Int

initialize

Called when the plugin is first added to the map.

open override fun initialize()

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onStart

Called whenever activity's/fragment's lifecycle is entering a "started" state.

open override fun onStart()

onStop

Called whenever activity's/fragment's lifecycle is entering a "stopped" state.

open override fun onStop()

onStyleChanged

Called when a new Style is loaded.

abstract override fun onStyleChanged(styleDelegate: StyleManagerInterface)

onStyleLoading

Called when a new Style is being loaded.

abstract override fun onStyleLoading()

setLocationProvider

Set the LocationProvider, it will replace the default location provider provided by the LocationComponentPlugin.

abstract fun setLocationProvider(locationProvider: LocationProvider)

toString

open override fun toString(): String

updateSettings

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

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

Properties

enabled

Whether the user location is visible on the map.

abstract override var enabled: Boolean

layerAbove

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

abstract override var layerAbove: String?

layerBelow

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

abstract override var layerBelow: String?

locationPuck

Defines what the customised look of the location puck.

abstract override var locationPuck: LocationPuck

pulsingColor

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

abstract override var pulsingColor: Int

pulsingEnabled

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

abstract override var pulsingEnabled: Boolean

pulsingMaxRadius

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

abstract override var pulsingMaxRadius: Float

Inheritors

LocationComponentPluginImpl