Builder

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

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

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

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

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

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

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.

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

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

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

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

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.

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

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.

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

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

Whether the user location is visible on the map.

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

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

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.

The enum controls how the puck is oriented

Whether the puck rotates to track the bearing source.

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

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

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.

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

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.