Builder

Set the opacity of the accuracy view to a value from 0 to 1, where 0 means the accuracy view is completely transparent and 1 means the view is completely opaque. References style attribute R.styleable#LocationComponent_accuracyAlpha

Enable or disable smooth animation of the accuracy circle around the user's position.

Solid color to use as the accuracy view color property. References style attribute R.styleable#LocationComponent_accuracyColor

Defines the drawable used for the background state icon. References style attribute R.styleable#LocationComponent_backgroundDrawable

Defines the drawable used for the stale background icon. References style attribute R.styleable#LocationComponent_backgroundDrawableStale

Given a String image name, identical to one used in the first parameter of , the component, will used this image in place of the provided or default mapbox_backgroundDrawable.

A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style.

Given a String image name, identical to one used in the first parameter of , the component, will used this image in place of the provided or default mapbox_backgroundDrawableStale.

A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style.

Defines the background stale color as an integer. References style attribute R.styleable#LocationComponent_backgroundStaleTintColor

Defines the background color as an integer. References style attribute R.styleable#LocationComponent_backgroundTintColor

Defines the drawable used for the bearing icon. References style attribute R.styleable#LocationComponent_bearingDrawable

Given a String image name, identical to one used in the first parameter of , the component, will used this image in place of the provided or default mapbox_bearingDrawable.

A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style.

Defines the bearing icon color as an integer. References style attribute R.styleable#LocationComponent_bearingTintColor

Build a new instance of this LocationComponentOptions class.

Enable or disable smooth animation of compass values for com.mapbox.maps.plugin.location.modes.CameraMode and com.mapbox.maps.plugin.location.modes.RenderMode .

Sets the base elevation of this view, in pixels. References style attribute R.styleable#LocationComponent_elevation

Enable or disable to stale state mode. This mode indicates to the user that the location being displayed on the map hasn't been updated in a specific amount of time. References style attribute R.styleable#LocationComponent_enableStaleState

Supply a Drawable that is to be rendered on top of all of the content in the Location Component layer stack. References style attribute R.styleable#LocationComponent_foregroundDrawable

Defines the drawable used for the stale foreground icon. References style attribute R.styleable#LocationComponent_foregroundDrawableStale

Given a String image name, identical to one used in the first parameter of , the component, will used this image in place of the provided or default mapbox_foregroundDrawable.

A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style.

Given a String image name, identical to one used in the first parameter of , the component, will used this image in place of the provided or default mapbox_foregroundDrawableStale.

A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style.

Defines the foreground stale color as an integer. References style attribute R.styleable#LocationComponent_foregroundStaleTintColor

Defines the foreground color as an integer. References style attribute R.styleable#LocationComponent_foregroundTintColor

Defines the drawable used for the navigation state icon. References style attribute R.styleable#LocationComponent_gpsDrawable

Given a String image name, identical to one used in the first parameter of , the component, will used this image in place of the provided or default mapbox_gpsDrawable.

A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style.

Sets the id of the layer that's referenced when placing the component on the map using .

The component is going to placed directly above this layer.

Sets the id of the layer that's referenced when placing the component on the map using .

The component is going to placed directly below this layer.

Sets the scale factor of the location icon when the map is zoomed in. Scaling is linear and the new pixel size of the image will be the original pixel size multiplied by the argument.

Set both this and minZoomIconScale to 1f to disable location icon scaling.

Scaling is based on the maps minimum and maximum zoom levels in time of component's style application.

Sets the scale factor of the location icon when the map is zoomed out. Scaling is linear and the new pixel size of the image will be the original pixel size multiplied by the argument.

Set both this and maxZoomIconScale to 1f to disable location icon scaling.

Scaling is based on the maps minimum and maximum zoom levels in time of component's style application.

Sets the distance from the edges of the map view’s frame to the edges of the map view’s logical viewport.

When the value of this property is equal to { 0,0,0,0 } , viewport properties such as `centerCoordinate` assume a viewport that matches the map view’s frame. Otherwise, those properties are inset, excluding part of the frame from the viewport. For instance, if the only the top edge is inset, the map center is effectively shifted downward.

Sets the opacity of the LocationComponent's pulsing circle. The expected range is 0 to 1. An opacity of 1 makes the layer fully visible.

Sets the color of the LocationComponent's pulsing circle.

Enable or disable the LocationComponent's pulsing circle.

Enable or disable fading of the LocationComponent's pulsing circle. If it fades, the circle's opacity decreases as its radius increases.

Sets the pulsing circle's interpolator animation.

The maximum radius that a single pulse should expand the LocationComponent's pulsing circle to.

Sets the number of milliseconds it takes for a single pulse of the LocationComponent's pulsing circle.

Set the timeout before the location icon becomes stale. The timer begins approximately when a new location update comes in and using this defined time, if an update hasn't occurred by the end, the location is considered stale. References style attribute R.styleable#LocationComponent_staleStateTimeout

Sets the tracking animation duration multiplier.

Set whether gesture threshold should be adjusted when camera is in one of the tracking modes. This will adjust the focal point and increase thresholds to enable camera manipulation, like zooming in and out, without breaking tracking.

Note: This can overwrite some of the gesture thresholds and the custom com.mapbox.android.gestures.AndroidGesturesManager that was set with .

Sets minimum single pointer movement (map pan) in pixels required to break camera tracking.

Sets minimum multi pointer movement (map pan) in pixels required to break camera tracking (for example during scale gesture).

Sets protected multi pointer gesture area. When the camera is in a tracking mode,any multi finger gesture with focal point inside the provided screen coordinate rectangle is not going to break the tracking.

Best paired with the trackingMultiFingerMoveThreshold set to 0 or a relatively small value to not interfere with gestures outside of the defined rectangle.