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

LocationComponentPluginImpl

class LocationComponentPluginImpl : LocationComponentSettingsBase2, LocationComponentPlugin2, LocationConsumer2

Default implementation of the LocationComponentPlugin, it renders the configured location puck to the user's current location.

Constructors

androidJvm

fun LocationComponentPluginImpl()

Functions

addOnIndicatorAccuracyRadiusChangedListener

androidJvm

open override fun addOnIndicatorAccuracyRadiusChangedListener(listener: OnIndicatorAccuracyRadiusChangedListener)

Adds a listener that gets invoked when indicator accuracy radius changes.

addOnIndicatorBearingChangedListener

androidJvm

open override fun addOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Adds a listener that gets invoked when indicator bearing changes.

addOnIndicatorPositionChangedListener

androidJvm

open override fun addOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Adds a listener that gets invoked when indicator position changes.

bind

androidJvm

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

Bind the ViewPlugin with current map context.

cleanup

androidJvm

open fun cleanup()

equals

androidJvm

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

getLocationProvider

androidJvm

open override fun getLocationProvider(): LocationProvider?

Get the current LocationProvider under usage with the LocationComponentPlugin.

getSettings

androidJvm

abstract fun getSettings(): LocationComponentSettings

getSettings2

androidJvm

abstract fun getSettings2(): LocationComponentSettings2

hashCode

androidJvm

open fun hashCode(): Int

initialize

androidJvm

open fun initialize()

isLocatedAt

androidJvm

open override fun isLocatedAt(point: Point, listener: PuckLocatedAtPointListener)

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

onAccuracyRadiusUpdated

androidJvm

open override fun onAccuracyRadiusUpdated(vararg radius: Double, options: ValueAnimator.() -> Unit?)

Called whenever the accuracy radius is updated.

onBearingUpdated

androidJvm

open override fun onBearingUpdated(vararg bearing: Double, options: ValueAnimator.() -> Unit?)

Called whenever the bearing is updated.

onDelegateProvider

androidJvm

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onLocationUpdated

androidJvm

open override fun onLocationUpdated(vararg location: Point, options: ValueAnimator.() -> Unit?)

Called whenever the location is updated.

onPuckAccuracyRadiusAnimatorDefaultOptionsUpdated

androidJvm

open override fun onPuckAccuracyRadiusAnimatorDefaultOptionsUpdated(options: ValueAnimator.() -> Unit)

Update ValueAnimator options that will be used to animate between accuracy radius Double updates by default.

onPuckBearingAnimatorDefaultOptionsUpdated

androidJvm

open override fun onPuckBearingAnimatorDefaultOptionsUpdated(options: ValueAnimator.() -> Unit)

Update ValueAnimator options that will be used to animate between bearing Double updates by default.

onPuckLocationAnimatorDefaultOptionsUpdated

androidJvm

open override fun onPuckLocationAnimatorDefaultOptionsUpdated(options: ValueAnimator.() -> Unit)

Update ValueAnimator options that will be used to animate between Point updates by default.

onStart

androidJvm

open override fun onStart()

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

onStop

androidJvm

open override fun onStop()

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

onStyleChanged

androidJvm

open override fun onStyleChanged(styleDelegate: StyleInterface)

Called when a new Style is loaded.

removeOnIndicatorAccuracyRadiusChangedListener

androidJvm

open override fun removeOnIndicatorAccuracyRadiusChangedListener(listener: OnIndicatorAccuracyRadiusChangedListener)

Removes a listener that gets invoked when indicator accuracy radius changes.

removeOnIndicatorBearingChangedListener

androidJvm

open override fun removeOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Removes a listener that gets invoked when indicator bearing changes.

removeOnIndicatorPositionChangedListener

androidJvm

open override fun removeOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Removes a listener that gets invoked when indicator position changes.

setLocationProvider

androidJvm

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

updateSettings2

androidJvm

abstract fun updateSettings2(block: LocationComponentSettings2.() -> Unit)

Properties

accuracyRingBorderColor

androidJvm

abstract var accuracyRingBorderColor: Int

accuracyRingColor

androidJvm

abstract var accuracyRingColor: Int

enabled

androidJvm

abstract var enabled: Boolean

layerAbove

androidJvm

abstract var layerAbove: String?

layerBelow

androidJvm

abstract var layerBelow: String?

locationPuck

androidJvm

abstract var locationPuck: LocationPuck

puckBearingEnabled

androidJvm

abstract var puckBearingEnabled: Boolean

puckBearingSource

androidJvm

abstract var puckBearingSource: PuckBearingSource

pulsingColor

androidJvm

abstract var pulsingColor: Int

pulsingEnabled

androidJvm

abstract var pulsingEnabled: Boolean

pulsingMaxRadius

androidJvm

abstract var pulsingMaxRadius: Float

showAccuracyRing

androidJvm

abstract var showAccuracyRing: Boolean