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

LocationComponentSettings

Shows a location puck on the map.

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

Constructors

LocationComponentSettings

@JvmOverloads()

fun LocationComponentSettings(enabled: Boolean, pulsingEnabled: Boolean, pulsingColor: Int, pulsingMaxRadius: Float, layerAbove: String?, layerBelow: String?, locationPuck: LocationPuck)

Functions

component1

operator fun component1(): Boolean

component2

operator fun component2(): Boolean

component3

operator fun component3(): Int

component4

operator fun component4(): Float

component5

operator fun component5(): String?

component6

operator fun component6(): String?

component7

operator fun component7(): LocationPuck

copy

fun copy(enabled: Boolean, pulsingEnabled: Boolean, pulsingColor: Int, pulsingMaxRadius: Float, layerAbove: String?, layerBelow: String?, locationPuck: LocationPuck): LocationComponentSettings

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

enabled

Whether the user location is visible on the map.

var enabled: Boolean

layerAbove

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

var layerAbove: String?

layerBelow

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

var layerBelow: String?

locationPuck

Defines what the customised look of the location puck.

var locationPuck: LocationPuck

pulsingColor

The color of the pulsing circle. Only work for 2D location puck.

var pulsingColor: Int

pulsingEnabled

Whether the location puck is pulsing on the map. Only work for 2D location puck.

var pulsingEnabled: Boolean

pulsingMaxRadius

The maximum radius of the pulsing circle. Only work for 2D location puck.

var pulsingMaxRadius: Float