LocationComponentSettings

Shows a location puck on the map.

Types

Link copied to clipboard
class Builder(var locationPuck: LocationPuck)

Composes and builds a LocationComponentSettings object.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Overloaded equals function.

Link copied to clipboard
open override fun hashCode(): Int

Overloaded hashCode function based on all class properties.

Link copied to clipboard

Convert to Builder allowing to change class properties.

Link copied to clipboard
open override fun toString(): String

Overloaded toString function.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Whether the user location is visible on the map.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The enum controls how the puck is oriented

Link copied to clipboard

Whether the puck rotates to track the bearing source.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val 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.