Mapbox Maps Android/com.mapbox.maps.plugin.location/LocationComponentOptions

LocationComponentOptions

This class exposes options for the Location Component. The options can be set by defining a style in your apps style.xml file and passing in directly into the LocationPluginImpl class. Alternatively, if properties need to be changed at runtime depending on a specific state, you can build an instance of this class, setting the values you desire, and then passing it into either the LocationPluginImpl activation method (if it isn't initialized yet) or applyStyle .

When the createFromAttributes methods called, any attributes not found inside the style will revert back to using their default set values. Likewise, when building a new LocationComponentOptions class using the builder, any options neglecting to be set will reset to their default values.

If you would like to keep your custom style changes while modifying a single attribute, you can get the currently used options object using getLocationComponentOptions and it's {@code toBuilder} method to modify a single entry while also maintaining the other settings. Once your modifications have been made, you'll need to pass it back into the location component using applyStyle .

Deprecated

Use LocationComponentPlugin instead.

@Deprecated()

open class LocationComponentOptions : Parcelable

Constructors

LocationComponentOptions

open fun LocationComponentOptions(accuracyAlpha: Float, accuracyColor: Int, backgroundDrawableStale: Int, backgroundStaleName: String, foregroundDrawableStale: Int, foregroundStaleName: String, gpsDrawable: Int, gpsName: String, foregroundDrawable: Int, foregroundName: String, backgroundDrawable: Int, backgroundName: String, bearingDrawable: Int, bearingName: String, bearingTintColor: Integer, foregroundTintColor: Integer, backgroundTintColor: Integer, foregroundStaleTintColor: Integer, backgroundStaleTintColor: Integer, elevation: Float, enableStaleState: Boolean, staleStateTimeout: Long, padding: Array<Int>, maxZoomIconScale: Float, minZoomIconScale: Float, trackingGesturesManagement: Boolean, trackingInitialMoveThreshold: Float, trackingMultiFingerMoveThreshold: Float, trackingMultiFingerProtectedMoveArea: RectF, layerAbove: String, layerBelow: String, trackingAnimationDurationMultiplier: Float, compassAnimationEnabled: Boolean, accuracyAnimationEnabled: Boolean, pulseEnabled: Boolean, pulseFadeEnabled: Boolean, pulseColor: Integer, pulseSingleDuration: Float, pulseMaxRadius: Float, pulseAlpha: Float, pulseInterpolator: Interpolator)

Types

Builder

Builder class for constructing a new instance of LocationComponentOptions .

open class Builder

Functions

accuracyAlpha

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

open fun accuracyAlpha(): Float

accuracyAnimationEnabled

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

open fun accuracyAnimationEnabled(): Boolean

accuracyColor

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

open fun accuracyColor(): Int

backgroundDrawable

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

@DrawableRes()

open fun backgroundDrawable(): Int

backgroundDrawableStale

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

@DrawableRes()

open fun backgroundDrawableStale(): Int

backgroundName

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.

@Nullable()

open fun backgroundName(): String

backgroundStaleName

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

@Nullable()

open fun backgroundStaleName(): String

backgroundStaleTintColor

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

@Nullable()

open fun backgroundStaleTintColor(): Integer

backgroundTintColor

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

@Nullable()

open fun backgroundTintColor(): Integer

bearingDrawable

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

@DrawableRes()

open fun bearingDrawable(): Int

bearingName

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.

@Nullable()

open fun bearingName(): String

bearingTintColor

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

@Nullable()

open fun bearingTintColor(): Integer

builder

Build a new instance of the LocationComponentOptions class with all the attributes set automatically to their defined defaults in this library. This allows you to adjust a few attributes while leaving the rest alone and maintaining their default behavior.

@NonNull()

open fun builder(context: Context): LocationComponentOptions.Builder

compassAnimationEnabled

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

open fun compassAnimationEnabled(): Boolean

createFromAttributes

Construct a new Location Component Options class using the attributes found within a style resource. It's important to note that you only need to define the attributes you plan to change and can safely ignore the other attributes which will be set to their default value.

@NonNull()

open fun createFromAttributes(context: Context, styleRes: Int): LocationComponentOptions

describeContents

abstract fun describeContents(): Int

{@inheritDoc}

open fun describeContents(): Int

elevation

Sets the base elevation of this view, in pixels. To turn off the shadow that appears under the location icon, set the elevation to 0. References style attribute R.styleable#LocationComponent_elevation

@Dimension()

open fun elevation(): Float

enableStaleState

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

open fun enableStaleState(): Boolean

equals

{@inheritDoc}

open fun equals(o: Any): Boolean

foregroundDrawable

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

@DrawableRes()

open fun foregroundDrawable(): Int

foregroundDrawableStale

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

@DrawableRes()

open fun foregroundDrawableStale(): Int

foregroundName

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.

@Nullable()

open fun foregroundName(): String

foregroundStaleName

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.

@Nullable()

open fun foregroundStaleName(): String

foregroundStaleTintColor

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

@Nullable()

open fun foregroundStaleTintColor(): Integer

foregroundTintColor

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

@Nullable()

open fun foregroundTintColor(): Integer

gpsDrawable

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

@DrawableRes()

open fun gpsDrawable(): Int

gpsName

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.

@Nullable()

open fun gpsName(): String

hashCode

{@inheritDoc}

open fun hashCode(): Int

layerAbove

Gets 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.

open fun layerAbove(): String

layerBelow

Gets 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.

open fun layerBelow(): String

maxZoomIconScale

The scale factor of the location icon when the map is zoomed in. Scaling is linear.

open fun maxZoomIconScale(): Float

minZoomIconScale

The scale factor of the location icon when the map is zoomed out. Scaling is linear.

open fun minZoomIconScale(): Float

padding

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.

@Nullable()

open fun padding(): Array<Int>

pulseAlpha

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

open fun pulseAlpha(): Float

pulseColor

Color of the LocationComponent's pulsing circle as it pulses.

open fun pulseColor(): Integer

pulseEnabled

Enable or disable the LocationComponent's pulsing circle.

open fun pulseEnabled(): Boolean

pulseFadeEnabled

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

open fun pulseFadeEnabled(): Boolean

pulseInterpolator

The interpolator type of animation for the movement of the LocationComponent's circle

@Nullable()

open fun pulseInterpolator(): Interpolator

pulseMaxRadius

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

open fun pulseMaxRadius(): Float

pulseSingleDuration

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

open fun pulseSingleDuration(): Float

staleStateTimeout

Set the delay 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 occured by the end, the location is considered stale. References style attribute R.styleable#LocationComponent_staleStateDelay

open fun staleStateTimeout(): Long

toBuilder

Takes the currently constructed LocationComponentOptions object and provides it's builder with all the values set matching the values in this instance. This allows you to modify a single attribute and then rebuild the object.

@NonNull()

open fun toBuilder(): LocationComponentOptions.Builder

toString

Convert object to string

@NonNull()

open fun toString(): String

trackingAnimationDurationMultiplier

Get the tracking animation duration multiplier.

open fun trackingAnimationDurationMultiplier(): Float

trackingGesturesManagement

Returns 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: If set to true, this can overwrite some of the gesture thresholds and the custom com.mapbox.android.gestures.AndroidGesturesManager that was set with .

open fun trackingGesturesManagement(): Boolean

trackingInitialMoveThreshold

Minimum single pointer movement in pixels required to break camera tracking.

open fun trackingInitialMoveThreshold(): Float

trackingMultiFingerMoveThreshold

Minimum multi pointer movement in pixels required to break camera tracking (for example during scale gesture).

open fun trackingMultiFingerMoveThreshold(): Float

trackingMultiFingerProtectedMoveArea

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.

@Nullable()

open fun trackingMultiFingerProtectedMoveArea(): RectF

writeToParcel

abstract fun writeToParcel(p: Parcel, p1: Int)

{@inheritDoc}

open fun writeToParcel(dest: Parcel, flags: Int)

Properties

CIRCLE_PULSING_MAX_RADIUS_DEFAULT

Default maximum radius of the LocationComponent circle when it's pulsing.

val CIRCLE_PULSING_MAX_RADIUS_DEFAULT: Float

CREATOR

Creator for parcelable implementation.

val CREATOR: Parcelable.Creator<LocationComponentOptions>