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
Link copied to clipboard
fun LocationComponentSettings(enabled: Boolean, pulsingEnabled: Boolean, pulsingColor: Int, pulsingMaxRadius: Float, layerAbove: String?, layerBelow: String?, locationPuck: LocationPuck)

Functions

component1
Link copied to clipboard
operator fun component1(): Boolean
component2
Link copied to clipboard
operator fun component2(): Boolean
component3
Link copied to clipboard
operator fun component3(): Int
component4
Link copied to clipboard
operator fun component4(): Float
component5
Link copied to clipboard
operator fun component5(): String?
component6
Link copied to clipboard
operator fun component6(): String?
component7
Link copied to clipboard
operator fun component7(): LocationPuck
copy
Link copied to clipboard
fun copy(enabled: Boolean, pulsingEnabled: Boolean, pulsingColor: Int, pulsingMaxRadius: Float, layerAbove: String?, layerBelow: String?, locationPuck: LocationPuck): LocationComponentSettings
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Properties

enabled
Link copied to clipboard

Whether the user location is visible on the map.

var enabled: Boolean
layerAbove
Link copied to clipboard

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

var layerAbove: String?
layerBelow
Link copied to clipboard

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

var layerBelow: String?
locationPuck
Link copied to clipboard

Defines what the customised look of the location puck.

var locationPuck: LocationPuck
pulsingColor
Link copied to clipboard

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

var pulsingColor: Int
pulsingEnabled
Link copied to clipboard

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

var pulsingEnabled: Boolean
pulsingMaxRadius
Link copied to clipboard

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

var pulsingMaxRadius: Float