mapbox-maps-android/com.mapbox.maps.plugin.locationcomponent/LocationComponentPlugin

LocationComponentPlugin

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

Define the interfaces for the Location plugin.

Functions

addOnIndicatorBearingChangedListener

androidJvm

abstract fun addOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Adds a listener that gets invoked when indicator bearing changes.

addOnIndicatorPositionChangedListener

androidJvm

abstract fun addOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Adds a listener that gets invoked when indicator position changes.

bind

androidJvm

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

Bind the ViewPlugin with current map context.

cleanup

androidJvm

open fun cleanup()

Called when the map is destroyed.

equals

androidJvm

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

getLocationProvider

androidJvm

abstract fun getLocationProvider(): LocationProvider?

Get the current LocationProvider under usage with the LocationComponentPlugin.

getSettings

androidJvm

abstract fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

hashCode

androidJvm

open fun hashCode(): Int

initialize

androidJvm

open fun initialize()

Called when the plugin is first added to the map.

isLocatedAt

androidJvm

abstract fun isLocatedAt(point: Point, listener: PuckLocatedAtPointListener)

Check whether the rendered location puck is on the given point.

onDelegateProvider

androidJvm

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onStart

androidJvm

open fun onStart()

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

onStop

androidJvm

open fun onStop()

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

onStyleChanged

androidJvm

abstract fun onStyleChanged(styleDelegate: StyleInterface)

Called when a new Style is loaded.

removeOnIndicatorBearingChangedListener

androidJvm

abstract fun removeOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Removes a listener that gets invoked when indicator bearing changes.

removeOnIndicatorPositionChangedListener

androidJvm

abstract fun removeOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Removes a listener that gets invoked when indicator position changes.

setLocationProvider

androidJvm

abstract fun setLocationProvider(locationProvider: LocationProvider)

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

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

LocationComponentPlugin2

Extensions

createDefault2DPuck

androidJvm

@JvmOverloads()

fun LocationComponentPlugin.createDefault2DPuck(context: Context, withBearing: Boolean = false): LocationPuck2D

Create a LocationPuck2D instance with or without an arrow bearing image.