LocationLayerOptions.Builder (plugin-locationlayer API)

java.lang.Object
- com.mapbox.mapboxsdk.plugins.locationlayer.LocationLayerOptions.Builder

Enclosing class:

LocationLayerOptions
```
public abstract static class LocationLayerOptions.Builder
extends java.lang.Object
```
Builder class for constructing a new instance of LocationLayerOptions.

Since:

0.4.0

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract LocationLayerOptions.Builder`	`accuracyAlpha(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 LocationLayerOptions.Builder`	`accuracyColor(int accuracyColor)` Solid color to use as the accuracy view color property.
`abstract LocationLayerOptions.Builder`	`backgroundDrawable(int backgroundDrawable)` Defines the drawable used for the background state icon.
`abstract LocationLayerOptions.Builder`	`backgroundDrawableStale(int backgroundDrawableStale)` Defines the drawable used for the stale background icon.
`abstract LocationLayerOptions.Builder`	`backgroundStaleTintColor(java.lang.Integer backgroundStaleTintColor)` Defines the background stale color as an integer.
`abstract LocationLayerOptions.Builder`	`backgroundTintColor(java.lang.Integer backgroundTintColor)` Defines the background color as an integer.
`abstract LocationLayerOptions.Builder`	`bearingDrawable(int bearingDrawable)` Defines the drawable used for the bearing icon.
`abstract LocationLayerOptions.Builder`	`bearingTintColor(java.lang.Integer bearingTintColor)` Defines the bearing icon color as an integer.
`LocationLayerOptions`	`build()` Build a new instance of this `LocationLayerOptions` class.
`abstract LocationLayerOptions.Builder`	`elevation(float elevation)` Sets the base elevation of this view, in pixels.
`abstract LocationLayerOptions.Builder`	`enableStaleState(boolean enabled)` Enable or disable to stale state mode.
`abstract LocationLayerOptions.Builder`	`foregroundDrawable(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 LocationLayerOptions.Builder`	`foregroundDrawableStale(int foregroundDrawableStale)` Defines the drawable used for the stale foreground icon.
`abstract LocationLayerOptions.Builder`	`foregroundStaleTintColor(java.lang.Integer foregroundStaleTintColor)` Defines the foreground stale color as an integer.
`abstract LocationLayerOptions.Builder`	`foregroundTintColor(java.lang.Integer foregroundTintColor)` Defines the foreground color as an integer.
`abstract LocationLayerOptions.Builder`	`gpsDrawable(int gpsDrawable)` Defines the drawable used for the navigation state icon.
`abstract LocationLayerOptions.Builder`	`maxZoom(double maxZoom)` Sets the maximum zoom level the map can be displayed at.
`abstract LocationLayerOptions.Builder`	`minZoom(double minZoom)` Sets the minimum zoom level the map can be displayed at.
`abstract LocationLayerOptions.Builder`	`padding(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 LocationLayerOptions.Builder`	`staleStateTimeout(long timeout)` Set the timeout before the location icon becomes stale.
`abstract LocationLayerOptions.Builder`	`trackingInitialMoveThreshold(float moveThreshold)` Sets minimum single pointer movement (map pan) in pixels required to break camera tracking.
`abstract LocationLayerOptions.Builder`	`trackingMultiFingerMoveThreshold(float moveThreshold)` Sets minimum multi pointer movement (map pan) 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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - accuracyAlpha
```
public abstract LocationLayerOptions.Builder accuracyAlpha(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.
    
    Parameters:
    
    accuracyAlpha - the opacity of the accuracy view
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - accuracyColor
```
public abstract LocationLayerOptions.Builder accuracyColor(int accuracyColor)
```
    Solid color to use as the accuracy view color property.
    
    Parameters:
    
    accuracyColor - the color of the accuracy view
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - foregroundDrawableStale
```
public abstract LocationLayerOptions.Builder foregroundDrawableStale(@DrawableRes
                                                                     int foregroundDrawableStale)
```
    Defines the drawable used for the stale foreground icon.
    
    Parameters:
    
    foregroundDrawableStale - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - foregroundStaleTintColor
```
public abstract LocationLayerOptions.Builder foregroundStaleTintColor(java.lang.Integer foregroundStaleTintColor)
```
    Defines the foreground stale color as an integer.
    
    Parameters:
    
    foregroundStaleTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - backgroundDrawableStale
```
public abstract LocationLayerOptions.Builder backgroundDrawableStale(@DrawableRes
                                                                     int backgroundDrawableStale)
```
    Defines the drawable used for the stale background icon.
    
    Parameters:
    
    backgroundDrawableStale - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - backgroundStaleTintColor
```
public abstract LocationLayerOptions.Builder backgroundStaleTintColor(java.lang.Integer backgroundStaleTintColor)
```
    Defines the background stale color as an integer.
    
    Parameters:
    
    backgroundStaleTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - gpsDrawable
```
public abstract LocationLayerOptions.Builder gpsDrawable(@DrawableRes
                                                         int gpsDrawable)
```
    Defines the drawable used for the navigation state icon.
    
    Parameters:
    
    gpsDrawable - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - foregroundDrawable
```
public abstract LocationLayerOptions.Builder foregroundDrawable(@DrawableRes
                                                                int foregroundDrawable)
```
    Supply a Drawable that is to be rendered on top of all of the content in the Location Layer Plugin layer stack.
    
    Parameters:
    
    foregroundDrawable - the drawable resource used for the foreground layer
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - backgroundDrawable
```
public abstract LocationLayerOptions.Builder backgroundDrawable(@DrawableRes
                                                                int backgroundDrawable)
```
    Defines the drawable used for the background state icon.
    
    Parameters:
    
    backgroundDrawable - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - bearingDrawable
```
public abstract LocationLayerOptions.Builder bearingDrawable(@DrawableRes
                                                             int bearingDrawable)
```
    Defines the drawable used for the bearing icon.
    
    Parameters:
    
    bearingDrawable - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - bearingTintColor
```
public abstract LocationLayerOptions.Builder bearingTintColor(java.lang.Integer bearingTintColor)
```
    Defines the bearing icon color as an integer.
    
    Parameters:
    
    bearingTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - foregroundTintColor
```
public abstract LocationLayerOptions.Builder foregroundTintColor(java.lang.Integer foregroundTintColor)
```
    Defines the foreground color as an integer.
    
    Parameters:
    
    foregroundTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - backgroundTintColor
```
public abstract LocationLayerOptions.Builder backgroundTintColor(java.lang.Integer backgroundTintColor)
```
    Defines the background color as an integer.
    
    Parameters:
    
    backgroundTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - elevation
```
public abstract LocationLayerOptions.Builder elevation(@Dimension
                                                       float elevation)
```
    Sets the base elevation of this view, in pixels.
    
    Parameters:
    
    elevation - the elevation currently set for the location layer icon
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - enableStaleState
```
public abstract LocationLayerOptions.Builder enableStaleState(boolean enabled)
```
    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.
    
    Parameters:
    
    enabled - whether the stale state mode is enabled or not
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - staleStateTimeout
```
public abstract LocationLayerOptions.Builder staleStateTimeout(long timeout)
```
    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.
    
    Parameters:
    
    timeout - the duration in milliseconds which it should take before the location layer is considered stale
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    0.4.0
  - padding
```
public abstract LocationLayerOptions.Builder padding(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.
    
    Parameters:
    
    padding - The margins for the map in pixels (left, top, right, bottom).
    
    Since:
    
    0.5.0
  - maxZoom
```
public abstract LocationLayerOptions.Builder maxZoom(double maxZoom)
```
    Sets the maximum zoom level the map can be displayed at.
    The default maximum zoomn level is 22. The upper bound for this value is 25.5.
    
    Parameters:
    
    maxZoom - The new maximum zoom level.
    
    Since:
    
    0.5.0
  - minZoom
```
public abstract LocationLayerOptions.Builder minZoom(double minZoom)
```
    Sets the minimum zoom level the map can be displayed at.
    
    Parameters:
    
    minZoom - The new minimum zoom level.
  - trackingInitialMoveThreshold
```
public abstract LocationLayerOptions.Builder trackingInitialMoveThreshold(float moveThreshold)
```
    Sets minimum single pointer movement (map pan) in pixels required to break camera tracking.
    
    Parameters:
    
    moveThreshold - the minimum movement
    
    Since:
    
    0.5.0
  - trackingMultiFingerMoveThreshold
```
public abstract LocationLayerOptions.Builder trackingMultiFingerMoveThreshold(float moveThreshold)
```
    Sets minimum multi pointer movement (map pan) in pixels required to break camera tracking (for example during scale gesture).
    
    Parameters:
    
    moveThreshold - the minimum movement
    
    Since:
    
    0.5.0
  - build
```
public LocationLayerOptions build()
```
    Build a new instance of this LocationLayerOptions class.
    
    Returns:
    
    a new instance of LocationLayerOptions
    
    Since:
    
    0.4.0

Class LocationLayerOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

accuracyAlpha

accuracyColor

foregroundDrawableStale

foregroundStaleTintColor

backgroundDrawableStale

backgroundStaleTintColor

gpsDrawable

foregroundDrawable

backgroundDrawable

bearingDrawable

bearingTintColor

foregroundTintColor

backgroundTintColor

elevation

enableStaleState

staleStateTimeout

padding

maxZoom

minZoom

trackingInitialMoveThreshold

trackingMultiFingerMoveThreshold

build