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

LocationComponentSettingsBase2

abstract class LocationComponentSettingsBase2 : LocationComponentSettingsBase, LocationComponentSettingsInterface2

Abstract settings class for LocationComponentPlugin.

This abstract class exposes all the required public APIs to configure the LocationComponentPlugin.

Constructors

androidJvm

fun LocationComponentSettingsBase2()

Functions

equals

androidJvm

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

getSettings

androidJvm

abstract fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

getSettings2

androidJvm

open override fun getSettings2(): LocationComponentSettings2

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.

updateSettings2

androidJvm

open override fun updateSettings2(block: LocationComponentSettings2.() -> Unit)

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

Properties

accuracyRingBorderColor

androidJvm

open override var accuracyRingBorderColor: Int

The color of the accuracy ring border.

accuracyRingColor

androidJvm

open override var accuracyRingColor: Int

The color of the accuracy ring.

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.

puckBearingEnabled

androidJvm

open override var puckBearingEnabled: Boolean

Whether the puck rotates to track the bearing source.

puckBearingSource

androidJvm

open override var puckBearingSource: PuckBearingSource

The enum controls how the puck is oriented

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.

showAccuracyRing

androidJvm

open override var showAccuracyRing: Boolean

Whether show accuracy ring with location puck.

Inheritors

LocationComponentPluginImpl