Builder

class Builder(var locationPuck: LocationPuck)

Composes and builds a LocationComponentSettings object.

This is a concrete implementation of the builder design pattern.

Constructors

Link copied to clipboard
fun Builder(locationPuck: LocationPuck)

Functions

Link copied to clipboard

Returns a LocationComponentSettings reference to the object being constructed by the builder.

Link copied to clipboard

Setter for accuracyRingBorderColor: the color of the accuracy ring border. Works for 2D location puck only.

Link copied to clipboard

Setter for accuracyRingColor: the color of the accuracy ring. Works for 2D location puck only.

Link copied to clipboard

Setter for enabled: whether the user location is visible on the map.

Link copied to clipboard

Setter for layerAbove: sets the id of the layer that's added above to when placing the component on the map.

Link copied to clipboard

Setter for layerBelow: sets the id of the layer that's added below to when placing the component on the map.

Link copied to clipboard

Setter for 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.

Link copied to clipboard

Setter for puckBearing: the enum controls how the puck is oriented.

Link copied to clipboard

Setter for puckBearingEnabled: whether the puck rotates to track the bearing source.

Link copied to clipboard

Setter for pulsingColor: the color of the pulsing circle. Works for 2D location puck only.

Link copied to clipboard

Setter for pulsingEnabled: whether the location puck is pulsing on the map. Works for 2D location puck only.

Link copied to clipboard

Setter for pulsingMaxRadius: 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

Setter for showAccuracyRing: whether show accuracy ring with location puck. Works for 2D location puck only.

Link copied to clipboard

Setter for slot: 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.

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
var enabled: Boolean = false

Whether the user location is visible on the map.

Link copied to clipboard
var layerAbove: String? = null

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

Link copied to clipboard
var layerBelow: String? = null

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
var pulsingEnabled: Boolean = false

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

Link copied to clipboard
var pulsingMaxRadius: Float = 10.0f

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
var slot: String? = null

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.