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

LocationComponentSettingsBase

abstract class LocationComponentSettingsBase : LocationComponentSettingsInterface

Abstract settings class for LocationComponentPlugin.

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

Constructors

LocationComponentSettingsBase

fun LocationComponentSettingsBase()

Functions

open override fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

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

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

Properties

accuracyRingBorderColor

open override var accuracyRingBorderColor: Int

The color of the accuracy ring border. Works for 2D location puck only.

accuracyRingColor

open override var accuracyRingColor: Int

The color of the accuracy ring. Works for 2D location puck only.

open override var enabled: Boolean

Whether the user location is visible on the map.

open override var layerAbove: String?

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

open override var layerBelow: String?

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

open override var locationPuck: LocationPuck

Defines what the customised look of the location puck. Note that direct changes to the puck variables won't have any effect, a new puck needs to be set every time.

open override var puckBearing: PuckBearing

The enum controls how the puck is oriented

puckBearingEnabled

open override var puckBearingEnabled: Boolean

Whether the puck rotates to track the bearing source.

open override var pulsingColor: Int

The color of the pulsing circle. Works for 2D location puck only.

open override var pulsingEnabled: Boolean

Whether the location puck is pulsing on the map. Works for 2D location puck only.

pulsingMaxRadius

open override var pulsingMaxRadius: Float

The maximum radius of the pulsing circle. Works for 2D location puck only. Note: Setting pulsingMaxRadius to LocationComponentConstants.PULSING_MAX_RADIUS_FOLLOW_ACCURACY will set the pulsing circle's maximum radius to follow location accuracy circle.

showAccuracyRing

open override var showAccuracyRing: Boolean

Whether show accuracy ring with location puck. Works for 2D location puck only.