com.mapbox.mapboxsdk.plugins.locationlayer

Class LocationLayerOptions

java.lang.Object

com.mapbox.mapboxsdk.plugins.locationlayer.LocationLayerOptions

All Implemented Interfaces:

android.os.Parcelable

public abstract class LocationLayerOptions
extends java.lang.Object
implements android.os.Parcelable

This class exposes options for the Location Layer Plugin. The options can be set by defining a style in your apps style.xml file and passing in directly into the LocationLayerPlugin 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 LocationLayerPlugin constructor (if it isn't initialized yet) or LocationLayerPlugin.applyStyle(LocationLayerOptions).

When the createFromAttributes(Context, int) methods called, any attributes not found inside the style will revert back to using their default set values. Likewise, when building a new LocationLayerOptions 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 LocationLayerPlugin.getLocationLayerOptions() and it's 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 layer plugin using LocationLayerPlugin.applyStyle(LocationLayerOptions).

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationLayerOptions.Builder Builder class for constructing a new instance of LocationLayerOptions.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
LocationLayerOptions()

Method Summary

Modifier and Type	Method and Description
abstract float	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.
abstract int	accuracyColor() Solid color to use as the accuracy view color property.
abstract int	backgroundDrawable() Defines the drawable used for the background state icon.
abstract int	backgroundDrawableStale() Defines the drawable used for the stale background icon.
abstract java.lang.Integer	backgroundStaleTintColor() Defines the background stale color as an integer.
abstract java.lang.Integer	backgroundTintColor() Defines the background color as an integer.
abstract int	bearingDrawable() Defines the drawable used for the bearing icon.
abstract java.lang.Integer	bearingTintColor() Defines the bearing icon color as an integer.
static LocationLayerOptions.Builder	builder(android.content.Context context) Build a new instance of the LocationLayerOptions class with all the attributes set automatically to their defined defaults in this library.
static LocationLayerOptions	createFromAttributes(android.content.Context context, int styleRes) Construct a new Location Layer Options class using the attributes found within a style resource.
abstract float	elevation() Sets the base elevation of this view, in pixels.
abstract boolean	enableStaleState() Enable or disable to stale state mode.
abstract int	foregroundDrawable() Supply a Drawable that is to be rendered on top of all of the content in the Location Layer Plugin layer stack.
abstract int	foregroundDrawableStale() Defines the drawable used for the stale foreground icon.
abstract java.lang.Integer	foregroundStaleTintColor() Defines the foreground stale color as an integer.
abstract java.lang.Integer	foregroundTintColor() Defines the foreground color as an integer.
abstract int	gpsDrawable() Defines the drawable used for the navigation state icon.
abstract double	maxZoom() The maximum zoom level the map can be displayed at.
abstract double	minZoom() The minimum zoom level the map can be displayed at.
abstract int[]	padding() Sets the distance from the edges of the map view’s frame to the edges of the map view’s logical viewport.
abstract long	staleStateTimeout() Set the delay before the location icon becomes stale.
abstract LocationLayerOptions.Builder	toBuilder() Takes the currently constructed LocationLayerOptions object and provides it's builder with all the values set matching the values in this instance.
abstract float	trackingInitialMoveThreshold() Minimum single pointer movement in pixels required to break camera tracking.
abstract float	trackingMultiFingerMoveThreshold() Minimum multi pointer movement in pixels required to break camera tracking (for example during scale gesture).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Constructor Detail

LocationLayerOptions

public LocationLayerOptions()

Method Detail

createFromAttributes

public static LocationLayerOptions createFromAttributes(@NonNull
                                                        android.content.Context context,
                                                        @StyleRes
                                                        int styleRes)

Construct a new Location Layer 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.

Parameters:

context - your activity's context used for acquiring resources

styleRes - the style id where your custom attributes are defined

Returns:

a new LocationLayerOptions object with the settings you defined in your style resource

Since:

0.4.0

toBuilder

public abstract LocationLayerOptions.Builder toBuilder()

Takes the currently constructed LocationLayerOptions 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.

Returns:

the Location Layer builder which contains the values defined in this current instance as defaults.

Since:

0.4.0

builder

public static LocationLayerOptions.Builder builder(android.content.Context context)

Build a new instance of the LocationLayerOptions 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.

Parameters:

context - your activities context used to acquire the style resource

Returns:

the Location Layer builder which contains the default values defined by the style resource

Since:

0.4.0

accuracyAlpha

public abstract float 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.

Returns:

the opacity of the accuracy view

Since:

0.4.0

accuracyColor

public abstract int accuracyColor()

Solid color to use as the accuracy view color property.

Returns:

the color of the accuracy view

Since:

0.4.0

backgroundDrawableStale

@DrawableRes
public abstract int backgroundDrawableStale()

Defines the drawable used for the stale background icon.

Returns:

the drawable resource ID

Since:

0.4.0

foregroundDrawableStale

@DrawableRes
public abstract int foregroundDrawableStale()

Defines the drawable used for the stale foreground icon.

Returns:

the drawable resource ID

Since:

0.4.0

gpsDrawable

@DrawableRes
public abstract int gpsDrawable()

Defines the drawable used for the navigation state icon.

Returns:

the drawable resource ID

Since:

0.4.0

foregroundDrawable

@DrawableRes
public abstract int foregroundDrawable()

Supply a Drawable that is to be rendered on top of all of the content in the Location Layer Plugin layer stack.

Returns:

the drawable resource used for the foreground layer

Since:

0.4.0

backgroundDrawable

@DrawableRes
public abstract int backgroundDrawable()

Defines the drawable used for the background state icon.

Returns:

the drawable resource ID

Since:

0.4.0

bearingDrawable

@DrawableRes
public abstract int bearingDrawable()

Defines the drawable used for the bearing icon.

Returns:

the drawable resource ID

Since:

0.4.0

bearingTintColor

@Nullable
public abstract java.lang.Integer bearingTintColor()

Defines the bearing icon color as an integer.

Returns:

the color integer resource

Since:

0.4.0

foregroundTintColor

@Nullable
public abstract java.lang.Integer foregroundTintColor()

Defines the foreground color as an integer.

Returns:

the color integer resource

Since:

0.4.0

backgroundTintColor

@Nullable
public abstract java.lang.Integer backgroundTintColor()

Defines the background color as an integer.

Returns:

the color integer resource

Since:

0.4.0

foregroundStaleTintColor

@Nullable
public abstract java.lang.Integer foregroundStaleTintColor()

Defines the foreground stale color as an integer.

Returns:

the color integer resource

Since:

0.4.0

backgroundStaleTintColor

@Nullable
public abstract java.lang.Integer backgroundStaleTintColor()

Defines the background stale color as an integer.

Returns:

the color integer resource

Since:

0.4.0

elevation

@Dimension
public abstract float elevation()

Sets the base elevation of this view, in pixels.

Returns:

the elevation currently set for the location layer icon

Since:

0.4.0

enableStaleState

public abstract boolean 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.

Returns:

whether the stale state mode is enabled or not

Since:

0.4.0

staleStateTimeout

public abstract long 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.

Returns:

the duration in milliseconds which it should take before the location layer is considered stale

Since:

0.4.0

padding

public abstract int[] 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.

Returns:

integer array of padding values

Since:

0.5.0

maxZoom

public abstract double maxZoom()

The maximum zoom level the map can be displayed at.

Returns:

the maximum zoom level

Since:

0.5.0

minZoom

public abstract double minZoom()

The minimum zoom level the map can be displayed at.

Returns:

the minimum zoom level

Since:

0.5.0

trackingInitialMoveThreshold

public abstract float trackingInitialMoveThreshold()

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

Returns:

the minimum movement

Since:

0.5.0

trackingMultiFingerMoveThreshold

public abstract float trackingMultiFingerMoveThreshold()

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

Returns:

the minimum movement

Since:

0.5.0