LocationComponentOptions.Builder

java.lang.Object
- com.dingi.dingisdk.location.LocationComponentOptions.Builder

Enclosing class:

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LocationComponentOptions.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.
`LocationComponentOptions.Builder`	`accuracyColor(int accuracyColor)` Solid color to use as the accuracy view color property.
`LocationComponentOptions.Builder`	`backgroundDrawable(int backgroundDrawable)` Defines the drawable used for the background state icon.
`LocationComponentOptions.Builder`	`backgroundDrawableStale(int backgroundDrawableStale)` Defines the drawable used for the stale background icon.
`LocationComponentOptions.Builder`	`backgroundName(java.lang.String backgroundName)` Given a String image name, identical to one used in the first parameter of `DingiMap.addImage(String, Bitmap)`, the component, will used this image in place of the provided or default dingi_backgroundDrawable.
`LocationComponentOptions.Builder`	`backgroundStaleName(java.lang.String backgroundStaleName)` Given a String image name, identical to one used in the first parameter of `DingiMap.addImage(String, Bitmap)`, the component, will used this image in place of the provided or default dingi_backgroundDrawableStale.
`LocationComponentOptions.Builder`	`backgroundStaleTintColor(java.lang.Integer backgroundStaleTintColor)` Defines the background stale color as an integer.
`LocationComponentOptions.Builder`	`backgroundTintColor(java.lang.Integer backgroundTintColor)` Defines the background color as an integer.
`LocationComponentOptions.Builder`	`bearingDrawable(int bearingDrawable)` Defines the drawable used for the bearing icon.
`LocationComponentOptions.Builder`	`bearingName(java.lang.String bearingName)` Given a String image name, identical to one used in the first parameter of `DingiMap.addImage(String, Bitmap)`, the component, will used this image in place of the provided or default dingi_bearingDrawable.
`LocationComponentOptions.Builder`	`bearingTintColor(java.lang.Integer bearingTintColor)` Defines the bearing icon color as an integer.
`LocationComponentOptions`	`build()` Build a new instance of this `LocationComponentOptions` class.
`LocationComponentOptions.Builder`	`elevation(float elevation)` Sets the base elevation of this view, in pixels.
`LocationComponentOptions.Builder`	`enableStaleState(boolean enabled)` Enable or disable to stale state mode.
`LocationComponentOptions.Builder`	`foregroundDrawable(int foregroundDrawable)` Supply a Drawable that is to be rendered on top of all of the content in the Location Component layer stack.
`LocationComponentOptions.Builder`	`foregroundDrawableStale(int foregroundDrawableStale)` Defines the drawable used for the stale foreground icon.
`LocationComponentOptions.Builder`	`foregroundName(java.lang.String foregroundName)` Given a String image name, identical to one used in the first parameter of `DingiMap.addImage(String, Bitmap)`, the component, will used this image in place of the provided or default dingi_foregroundDrawable.
`LocationComponentOptions.Builder`	`foregroundStaleName(java.lang.String foregroundStaleName)` Given a String image name, identical to one used in the first parameter of `DingiMap.addImage(String, Bitmap)`, the component, will used this image in place of the provided or default dingi_foregroundDrawableStale.
`LocationComponentOptions.Builder`	`foregroundStaleTintColor(java.lang.Integer foregroundStaleTintColor)` Defines the foreground stale color as an integer.
`LocationComponentOptions.Builder`	`foregroundTintColor(java.lang.Integer foregroundTintColor)` Defines the foreground color as an integer.
`LocationComponentOptions.Builder`	`gpsDrawable(int gpsDrawable)` Defines the drawable used for the navigation state icon.
`LocationComponentOptions.Builder`	`gpsName(java.lang.String gpsName)` Given a String image name, identical to one used in the first parameter of `DingiMap.addImage(String, Bitmap)`, the component, will used this image in place of the provided or default dingi_gpsDrawable.
`LocationComponentOptions.Builder`	`layerBelow(java.lang.String layerBelow)` Sets the layer id to set the location component below to.
`LocationComponentOptions.Builder`	`maxZoom(double maxZoom)` Sets the maximum zoom level the map can be displayed at.
`LocationComponentOptions.Builder`	`maxZoomIconScale(float maxZoomIconScale)` Sets the scale factor of the location icon when the map is zoomed in.
`LocationComponentOptions.Builder`	`minZoom(double minZoom)` Sets the minimum zoom level the map can be displayed at.
`LocationComponentOptions.Builder`	`minZoomIconScale(float minZoomIconScale)` Sets the scale factor of the location icon when the map is zoomed out.
`LocationComponentOptions.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.
`LocationComponentOptions.Builder`	`staleStateTimeout(long timeout)` Set the timeout before the location icon becomes stale.
`LocationComponentOptions.Builder`	`trackingAnimationDurationMultiplier(float trackingAnimationDurationMultiplier)` Sets the tracking animation duration multiplier.
`LocationComponentOptions.Builder`	`trackingGesturesManagement(boolean trackingGesturesManagement)` Set whether gesture threshold should be adjusted when camera is in one of the tracking modes.
`LocationComponentOptions.Builder`	`trackingInitialMoveThreshold(float moveThreshold)` Sets minimum single pointer movement (map pan) in pixels required to break camera tracking.
`LocationComponentOptions.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

- Method Detail
  - build
```
@NonNull
public LocationComponentOptions build()
```
    Build a new instance of this LocationComponentOptions class.
    
    Returns:
    
    a new instance of LocationComponentOptions
  - accuracyAlpha
```
@NonNull
public LocationComponentOptions.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
  - accuracyColor
```
@NonNull
public LocationComponentOptions.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
  - backgroundDrawableStale
```
@NonNull
public LocationComponentOptions.Builder backgroundDrawableStale(int backgroundDrawableStale)
```
    Defines the drawable used for the stale background icon.
    
    Parameters:
    
    backgroundDrawableStale - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
  - backgroundStaleName
```
@NonNull
public LocationComponentOptions.Builder backgroundStaleName(@Nullable
                                                                     java.lang.String backgroundStaleName)
```
    Given a String image name, identical to one used in the first parameter of DingiMap.addImage(String, Bitmap), the component, will used this image in place of the provided or default dingi_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.
    
    Parameters:
    
    backgroundStaleName - String icon or maki-icon name
    
    Returns:
    
    this builder for chaining options together
  - foregroundDrawableStale
```
@NonNull
public LocationComponentOptions.Builder foregroundDrawableStale(int foregroundDrawableStale)
```
    Defines the drawable used for the stale foreground icon.
    
    Parameters:
    
    foregroundDrawableStale - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
  - foregroundStaleName
```
@NonNull
public LocationComponentOptions.Builder foregroundStaleName(@Nullable
                                                                     java.lang.String foregroundStaleName)
```
    Given a String image name, identical to one used in the first parameter of DingiMap.addImage(String, Bitmap), the component, will used this image in place of the provided or default dingi_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.
    
    Parameters:
    
    foregroundStaleName - String icon or maki-icon name
    
    Returns:
    
    this builder for chaining options together
  - gpsDrawable
```
@NonNull
public LocationComponentOptions.Builder gpsDrawable(int gpsDrawable)
```
    Defines the drawable used for the navigation state icon.
    
    Parameters:
    
    gpsDrawable - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
  - gpsName
```
@NonNull
public LocationComponentOptions.Builder gpsName(@Nullable
                                                         java.lang.String gpsName)
```
    Given a String image name, identical to one used in the first parameter of DingiMap.addImage(String, Bitmap), the component, will used this image in place of the provided or default dingi_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.
    
    Parameters:
    
    gpsName - String icon or maki-icon name
    
    Returns:
    
    this builder for chaining options together
  - foregroundDrawable
```
@NonNull
public LocationComponentOptions.Builder foregroundDrawable(int foregroundDrawable)
```
    Supply a Drawable that is to be rendered on top of all of the content in the Location Component layer stack.
    
    Parameters:
    
    foregroundDrawable - the drawable resource used for the foreground layer
    
    Returns:
    
    this builder for chaining options together
  - foregroundName
```
@NonNull
public LocationComponentOptions.Builder foregroundName(@Nullable
                                                                java.lang.String foregroundName)
```
    Given a String image name, identical to one used in the first parameter of DingiMap.addImage(String, Bitmap), the component, will used this image in place of the provided or default dingi_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.
    
    Parameters:
    
    foregroundName - String icon or maki-icon name
    
    Returns:
    
    this builder for chaining options together
  - backgroundDrawable
```
@NonNull
public LocationComponentOptions.Builder backgroundDrawable(int backgroundDrawable)
```
    Defines the drawable used for the background state icon.
    
    Parameters:
    
    backgroundDrawable - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
  - backgroundName
```
@NonNull
public LocationComponentOptions.Builder backgroundName(@Nullable
                                                                java.lang.String backgroundName)
```
    Given a String image name, identical to one used in the first parameter of DingiMap.addImage(String, Bitmap), the component, will used this image in place of the provided or default dingi_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.
    
    Parameters:
    
    backgroundName - String icon or maki-icon name
    
    Returns:
    
    this builder for chaining options together
  - bearingDrawable
```
@NonNull
public LocationComponentOptions.Builder bearingDrawable(int bearingDrawable)
```
    Defines the drawable used for the bearing icon.
    
    Parameters:
    
    bearingDrawable - the drawable resource ID
    
    Returns:
    
    this builder for chaining options together
  - bearingName
```
@NonNull
public LocationComponentOptions.Builder bearingName(@Nullable
                                                             java.lang.String bearingName)
```
    Given a String image name, identical to one used in the first parameter of DingiMap.addImage(String, Bitmap), the component, will used this image in place of the provided or default dingi_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.
    
    Parameters:
    
    bearingName - String icon or maki-icon name
    
    Returns:
    
    this builder for chaining options together
  - bearingTintColor
```
@NonNull
public LocationComponentOptions.Builder bearingTintColor(@Nullable
                                                                  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
  - foregroundTintColor
```
@NonNull
public LocationComponentOptions.Builder foregroundTintColor(@Nullable
                                                                     java.lang.Integer foregroundTintColor)
```
    Defines the foreground color as an integer.
    
    Parameters:
    
    foregroundTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
  - backgroundTintColor
```
@NonNull
public LocationComponentOptions.Builder backgroundTintColor(@Nullable
                                                                     java.lang.Integer backgroundTintColor)
```
    Defines the background color as an integer.
    
    Parameters:
    
    backgroundTintColor - the color integer resource
    
    Returns:
    
    this builder for chaining options together
  - foregroundStaleTintColor
```
@NonNull
public LocationComponentOptions.Builder foregroundStaleTintColor(@Nullable
                                                                          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
  - backgroundStaleTintColor
```
@NonNull
public LocationComponentOptions.Builder backgroundStaleTintColor(@Nullable
                                                                          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
  - elevation
```
@NonNull
public LocationComponentOptions.Builder elevation(float elevation)
```
    Sets the base elevation of this view, in pixels.
    
    Parameters:
    
    elevation - the elevation currently set for the location icon
    
    Returns:
    
    this builder for chaining options together
  - enableStaleState
```
@NonNull
public LocationComponentOptions.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
  - staleStateTimeout
```
@NonNull
public LocationComponentOptions.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 is considered stale
    
    Returns:
    
    this builder for chaining options together
  - padding
```
@NonNull
public LocationComponentOptions.Builder padding(@Nullable
                                                         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).
  - maxZoom
```
@NonNull
public LocationComponentOptions.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.
  - minZoom
```
@NonNull
public LocationComponentOptions.Builder minZoom(double minZoom)
```
    Sets the minimum zoom level the map can be displayed at.
    
    Parameters:
    
    minZoom - The new minimum zoom level.
  - maxZoomIconScale
```
@NonNull
public LocationComponentOptions.Builder maxZoomIconScale(float maxZoomIconScale)
```
    Sets the scale factor of the location icon when the map is zoomed in. Based on LocationComponentOptions.maxZoom(). 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(float) to 1f to disable location icon scaling.
    
    Parameters:
    
    maxZoomIconScale - icon scale factor
  - minZoomIconScale
```
@NonNull
public LocationComponentOptions.Builder minZoomIconScale(float minZoomIconScale)
```
    Sets the scale factor of the location icon when the map is zoomed out. Based on LocationComponentOptions.maxZoom(). 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(float) to 1f to disable location icon scaling.
    
    Parameters:
    
    minZoomIconScale - icon scale factor
  - trackingGesturesManagement
```
@NonNull
public LocationComponentOptions.Builder trackingGesturesManagement(boolean trackingGesturesManagement)
```
    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 AndroidGesturesManager that was set with DingiMap.setGesturesManager(AndroidGesturesManager, boolean, boolean).
    
    Parameters:
    
    trackingGesturesManagement - true if gestures should be adjusted when in one of the camera tracking modes, false otherwise
    
    See Also:
    
    trackingInitialMoveThreshold(float), trackingMultiFingerMoveThreshold(float)
  - trackingInitialMoveThreshold
```
@NonNull
public LocationComponentOptions.Builder trackingInitialMoveThreshold(float moveThreshold)
```
    Sets minimum single pointer movement (map pan) in pixels required to break camera tracking.
    
    Parameters:
    
    moveThreshold - the minimum movement
  - trackingMultiFingerMoveThreshold
```
@NonNull
public LocationComponentOptions.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
  - layerBelow
```
@NonNull
public LocationComponentOptions.Builder layerBelow(java.lang.String layerBelow)
```
    Sets the layer id to set the location component below to.
    
    Parameters:
    
    layerBelow - the id to set the location component below to.
  - trackingAnimationDurationMultiplier
```
@NonNull
public LocationComponentOptions.Builder trackingAnimationDurationMultiplier(float trackingAnimationDurationMultiplier)
```
    Sets the tracking animation duration multiplier.
    
    Parameters:
    
    trackingAnimationDurationMultiplier - the tracking animation duration multiplier

Class LocationComponentOptions.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

accuracyAlpha

accuracyColor

backgroundDrawableStale

backgroundStaleName

foregroundDrawableStale

foregroundStaleName

gpsDrawable

gpsName

foregroundDrawable

foregroundName

backgroundDrawable

backgroundName

bearingDrawable

bearingName

bearingTintColor

foregroundTintColor

backgroundTintColor

foregroundStaleTintColor

backgroundStaleTintColor

elevation

enableStaleState

staleStateTimeout

padding

maxZoom

minZoom

maxZoomIconScale

minZoomIconScale

trackingGesturesManagement

trackingInitialMoveThreshold

trackingMultiFingerMoveThreshold

layerBelow

trackingAnimationDurationMultiplier