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

fun LocationComponentSettingsBase()

Functions

getSettings

open override fun getSettings(): LocationComponentSettings

Get current locationcomponent configuration.

updateSettings

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. Default value: "#4d89cff0".

accuracyRingColor

open override var accuracyRingColor: Int

The color of the accuracy ring. Works for 2D location puck only. Default value: "#4d89cff0".

enabled

open override var enabled: Boolean

Whether the user location is visible on the map. Default value: false.

layerAbove

open override var layerAbove: String?

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

layerBelow

open override var layerBelow: String?

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

locationPuck

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.

puckBearing

open override var puckBearing: PuckBearing

The enum controls how the puck is oriented Default value: "heading".

puckBearingEnabled

open override var puckBearingEnabled: Boolean

Whether the puck rotates to track the bearing source. Default value: false.

pulsingColor

open override var pulsingColor: Int

The color of the pulsing circle. Works for 2D location puck only. Default value: "#4A90E2".

pulsingEnabled

open override var pulsingEnabled: Boolean

Whether the location puck is pulsing on the map. Works for 2D location puck only. Default value: false.

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. Default value: 10.

showAccuracyRing

open override var showAccuracyRing: Boolean

Whether show accuracy ring with location puck. Works for 2D location puck only. Default value: false.

slot

open override var slot: String?

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.