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

LocationComponentSettings

class LocationComponentSettings : Parcelable

Shows a location puck on the map.

Types

class Builder(var locationPuck: LocationPuck)

Composes and builds a LocationComponentSettings object.

Functions

describeContents

abstract fun describeContents(): Int

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

Overloaded equals function.

open override fun hashCode(): Int

Overloaded hashCode function based on all class properties.

fun toBuilder(): LocationComponentSettings.Builder

Convert to Builder allowing to change class properties.

open override fun toString(): String

Overloaded toString function.

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

accuracyRingBorderColor

val accuracyRingBorderColor: Int

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

accuracyRingColor

val accuracyRingColor: Int

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

val enabled: Boolean

Whether the user location is visible on the map.

val layerAbove: String?

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

val layerBelow: String?

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

val 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.

val puckBearing: PuckBearing

The enum controls how the puck is oriented

puckBearingEnabled

val puckBearingEnabled: Boolean

Whether the puck rotates to track the bearing source.

val pulsingColor: Int

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

val pulsingEnabled: Boolean

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

pulsingMaxRadius

val 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. This property is specified in pixels.

showAccuracyRing

val showAccuracyRing: Boolean

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