LocationComponentSettings

data class LocationComponentSettings @JvmOverloads constructor(enabled: Boolean, pulsingEnabled: Boolean, pulsingColor: Int, pulsingMaxRadius: Float, layerAbove: String?, layerBelow: String?, locationPuck: LocationPuck)

Shows a location puck on the map.

Constructors

@JvmOverloads

fun LocationComponentSettings(enabled: Boolean = false, pulsingEnabled: Boolean = false, pulsingColor: Int = Color.parseColor("#4A90E2"), pulsingMaxRadius: Float = 10f, layerAbove: String? = null, layerBelow: String? = null, locationPuck: LocationPuck)

Properties

enabled

var enabled: Boolean = false

Whether the user location is visible on the map.

layerAbove

var layerAbove: String? = null

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

layerBelow

var layerBelow: String? = null

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

locationPuck

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.

pulsingColor

var pulsingColor: Int

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

pulsingEnabled

var pulsingEnabled: Boolean = false

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

pulsingMaxRadius

var pulsingMaxRadius: Float = 10f

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.