UiSettings

java.lang.Object
- com.dingi.dingisdk.maps.UiSettings

```
public final class UiSettings
extends java.lang.Object
```
Settings for the user interface of a DingiMap. To obtain this interface, call getUiSettings().

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttributionDialogManager`	`getAttributionDialogManager()` Get the custom attribution dialog manager.
`int`	`getAttributionGravity()` Returns the gravity value of the logo
`int`	`getAttributionMarginBottom()` Returns the bottom side margin of the logo
`int`	`getAttributionMarginLeft()` Returns the left side margin of the attribution view.
`int`	`getAttributionMarginRight()` Returns the right side margin of the attribution view.
`int`	`getAttributionMarginTop()` Returns the top side margin of the attribution view.
`int`	`getCompassGravity()` Returns the gravity value of the CompassView
`android.graphics.drawable.Drawable`	`getCompassImage()` Get the current configured CompassView image.
`int`	`getCompassMarginBottom()` Returns the bottom side margin of CompassView
`int`	`getCompassMarginLeft()` Returns the left side margin of CompassView
`int`	`getCompassMarginRight()` Returns the right side margin of CompassView
`int`	`getCompassMarginTop()` Returns the top side margin of CompassView
`android.graphics.PointF`	`getFocalPoint()` Returns the gesture focal point
`float`	`getHeight()` Returns the measured height of the MapView
`int`	`getLogoGravity()` Returns the gravity value of the logo
`int`	`getLogoMarginBottom()` Returns the bottom side margin of the logo
`int`	`getLogoMarginLeft()` Returns the left side margin of the logo
`int`	`getLogoMarginRight()` Returns the right side margin of the logo
`int`	`getLogoMarginTop()` Returns the top side margin of the logo
`float`	`getWidth()` Returns the measured width of the MapView
`void`	`invalidate()` Invalidates the ViewSettings instances shown on top of the MapView
`boolean`	`isAttributionEnabled()` Returns whether the attribution is enabled.
`boolean`	`isCompassEnabled()` Returns whether the compass is enabled.
`boolean`	`isCompassFadeWhenFacingNorth()` Returns whether the compass performs a fading animation out when facing north.
`boolean`	`isDeselectMarkersOnTap()` Gets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.
`boolean`	`isDoubleTapGesturesEnabled()` Returns whether the user may zoom the map with a double tap.
`boolean`	`isFlingVelocityAnimationEnabled()` Returns whether fling velocity animation should execute after users finishes a gesture.
`boolean`	`isIncreaseRotateThresholdWhenScaling()` Returns whether rotation threshold should be increase whenever scale is detected.
`boolean`	`isIncreaseScaleThresholdWhenRotating()` Returns whether scale threshold should be increase whenever rotation is detected.
`boolean`	`isLogoEnabled()` Returns whether the logo is enabled.
`boolean`	`isRotateGesturesEnabled()` Returns whether the user may rotate the map.
`boolean`	`isRotateVelocityAnimationEnabled()` Returns whether rotate velocity animation should execute after users finishes a gesture.
`boolean`	`isScaleVelocityAnimationEnabled()` Returns whether scale velocity animation should execute after users finishes a gesture.
`boolean`	`isScrollGesturesEnabled()` Returns whether the user may scroll around the map.
`boolean`	`isTiltGesturesEnabled()` Returns whether the user may tilt the map.
`boolean`	`isZoomGesturesEnabled()` Returns whether the user may zoom the map.
`void`	`setAllGesturesEnabled(boolean enabled)` Sets the preference for whether all gestures should be enabled or disabled.
`void`	`setAllVelocityAnimationsEnabled(boolean allVelocityAnimationsEnabled)` Set whether all velocity animations should execute after users finishes a gesture.
`void`	`setAttributionDialogManager(AttributionDialogManager attributionDialogManager)` Set a custom attribution dialog manager.
`void`	`setAttributionEnabled(boolean enabled)` Enables or disables the attribution.
`void`	`setAttributionGravity(int gravity)` Sets the gravity of the attribution.
`void`	`setAttributionMargins(int left, int top, int right, int bottom)` Sets the margins of the attribution view.
`void`	`setAttributionTintColor(int tintColor)` Sets the tint of the attribution view.
`void`	`setCompassEnabled(boolean compassEnabled)` Enables or disables the compass.
`void`	`setCompassFadeFacingNorth(boolean compassFadeFacingNorth)` Enables or disables fading of the compass when facing north.
`void`	`setCompassGravity(int gravity)` Sets the gravity of the compass view.
`void`	`setCompassImage(android.graphics.drawable.Drawable compass)` Specifies the CompassView image.
`void`	`setCompassMargins(int left, int top, int right, int bottom)` Sets the margins of the compass view.
`void`	`setDeselectMarkersOnTap(boolean deselectMarkersOnTap)` Sets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.
`void`	`setDoubleTapGesturesEnabled(boolean doubleTapGesturesEnabled)` Changes whether the user may zoom the map with a double tap.
`void`	`setFlingVelocityAnimationEnabled(boolean flingVelocityAnimationEnabled)` Set whether fling velocity animation should execute after users finishes a gesture.
`void`	`setFocalPoint(android.graphics.PointF focalPoint)` Sets the focal point used as center for a gesture
`void`	`setIncreaseRotateThresholdWhenScaling(boolean increaseRotateThresholdWhenScaling)` Set whether rotation threshold should be increase whenever scale is detected.
`void`	`setIncreaseScaleThresholdWhenRotating(boolean increaseScaleThresholdWhenRotating)` set whether scale threshold should be increase whenever rotation is detected.
`void`	`setLogoEnabled(boolean enabled)` Enables or disables the Dingi logo.
`void`	`setLogoGravity(int gravity)` Sets the gravity of the logo view.
`void`	`setLogoMargins(int left, int top, int right, int bottom)` Sets the margins of the logo view.
`void`	`setRotateGesturesEnabled(boolean rotateGesturesEnabled)` Changes whether the user may rotate the map.
`void`	`setRotateVelocityAnimationEnabled(boolean rotateVelocityAnimationEnabled)` Set whether rotate velocity animation should execute after users finishes a gesture.
`void`	`setScaleVelocityAnimationEnabled(boolean scaleVelocityAnimationEnabled)` Set whether scale velocity animation should execute after users finishes a gesture.
`void`	`setScrollGesturesEnabled(boolean scrollGesturesEnabled)` Changes whether the user may scroll around the map.
`void`	`setTiltGesturesEnabled(boolean tiltGesturesEnabled)` Changes whether the user may tilt the map.
`void`	`setZoomGesturesEnabled(boolean zoomGesturesEnabled)` Changes whether the user may zoom the map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setCompassEnabled
```
public void setCompassEnabled(boolean compassEnabled)
```
    Enables or disables the compass. The compass is an icon on the map that indicates the direction of north on the map. When a user clicks the compass, the camera orients itself to its default orientation and fades away shortly after. If disabled, the compass will never be displayed.
    By default, the compass is enabled.
    
    Parameters:
    
    compassEnabled - True to enable the compass; false to disable the compass.
  - isCompassEnabled
```
public boolean isCompassEnabled()
```
    Returns whether the compass is enabled.
    
    Returns:
    
    True if the compass is enabled; false if the compass is disabled.
  - setCompassGravity
```
@UiThread
public void setCompassGravity(int gravity)
```
    Sets the gravity of the compass view. Use this to change the corner of the map view that the compass is displayed in.
    By default, the compass is in the top right corner.
    
    Parameters:
    
    gravity - Android SDK Gravity.
  - setCompassFadeFacingNorth
```
public void setCompassFadeFacingNorth(boolean compassFadeFacingNorth)
```
    Enables or disables fading of the compass when facing north.
    By default this feature is enabled
    
    Parameters:
    
    compassFadeFacingNorth - True to enable the fading animation; false to disable it
  - setCompassImage
```
public void setCompassImage(@NonNull
                            android.graphics.drawable.Drawable compass)
```
    Specifies the CompassView image.
    By default this value is R.drawable.compass_icon.
    
    Parameters:
    
    compass - the drawable to show as image compass
  - isCompassFadeWhenFacingNorth
```
public boolean isCompassFadeWhenFacingNorth()
```
    Returns whether the compass performs a fading animation out when facing north.
    
    Returns:
    
    True if the compass will fade, false if it remains visible
  - getCompassGravity
```
public int getCompassGravity()
```
    Returns the gravity value of the CompassView
    
    Returns:
    
    The gravity
  - setCompassMargins
```
@UiThread
public void setCompassMargins(int left,
                                        int top,
                                        int right,
                                        int bottom)
```
    Sets the margins of the compass view. Use this to change the distance of the compass from the map view edge.
    
    Parameters:
    
    left - The left margin in pixels.
    
    top - The top margin in pixels.
    
    right - The right margin in pixels.
    
    bottom - The bottom margin in pixels.
  - getCompassMarginLeft
```
public int getCompassMarginLeft()
```
    Returns the left side margin of CompassView
    
    Returns:
    
    The left margin in pixels
  - getCompassMarginTop
```
public int getCompassMarginTop()
```
    Returns the top side margin of CompassView
    
    Returns:
    
    The top margin in pixels
  - getCompassMarginRight
```
public int getCompassMarginRight()
```
    Returns the right side margin of CompassView
    
    Returns:
    
    The right margin in pixels
  - getCompassMarginBottom
```
public int getCompassMarginBottom()
```
    Returns the bottom side margin of CompassView
    
    Returns:
    
    The bottom margin in pixels
  - getCompassImage
```
@NonNull
public android.graphics.drawable.Drawable getCompassImage()
```
    Get the current configured CompassView image.
    
    Returns:
    
    the drawable used as compass image
  - setLogoEnabled
```
public void setLogoEnabled(boolean enabled)
```
    Enables or disables the Dingi logo.
    By default, the logo is enabled.
    
    Parameters:
    
    enabled - True to enable the logo; false to disable the logo.
  - isLogoEnabled
```
public boolean isLogoEnabled()
```
    Returns whether the logo is enabled.
    
    Returns:
    
    True if the logo is enabled; false if the logo is disabled.
  - setLogoGravity
```
public void setLogoGravity(int gravity)
```
    Sets the gravity of the logo view. Use this to change the corner of the map view that the Dingi logo is displayed in.
    By default, the logo is in the bottom left corner.
    
    Parameters:
    
    gravity - Android SDK Gravity.
  - getLogoGravity
```
public int getLogoGravity()
```
    Returns the gravity value of the logo
    
    Returns:
    
    The gravity
  - setLogoMargins
```
public void setLogoMargins(int left,
                           int top,
                           int right,
                           int bottom)
```
    Sets the margins of the logo view. Use this to change the distance of the Dingi logo from the map view edge.
    
    Parameters:
    
    left - The left margin in pixels.
    
    top - The top margin in pixels.
    
    right - The right margin in pixels.
    
    bottom - The bottom margin in pixels.
  - getLogoMarginLeft
```
public int getLogoMarginLeft()
```
    Returns the left side margin of the logo
    
    Returns:
    
    The left margin in pixels
  - getLogoMarginTop
```
public int getLogoMarginTop()
```
    Returns the top side margin of the logo
    
    Returns:
    
    The top margin in pixels
  - getLogoMarginRight
```
public int getLogoMarginRight()
```
    Returns the right side margin of the logo
    
    Returns:
    
    The right margin in pixels
  - getLogoMarginBottom
```
public int getLogoMarginBottom()
```
    Returns the bottom side margin of the logo
    
    Returns:
    
    The bottom margin in pixels
  - setAttributionEnabled
```
public void setAttributionEnabled(boolean enabled)
```
    Enables or disables the attribution.
    By default, the attribution is enabled.
    
    Parameters:
    
    enabled - True to enable the attribution; false to disable the attribution.
  - isAttributionEnabled
```
public boolean isAttributionEnabled()
```
    Returns whether the attribution is enabled.
    
    Returns:
    
    True if the attribution is enabled; false if the attribution is disabled.
  - setAttributionDialogManager
```
public void setAttributionDialogManager(@NonNull
                                        AttributionDialogManager attributionDialogManager)
```
    Set a custom attribution dialog manager.
    Set to null to reset to default behaviour.
    
    Parameters:
    
    attributionDialogManager - the manager class used for showing attribution
  - getAttributionDialogManager
```
@NonNull
public AttributionDialogManager getAttributionDialogManager()
```
    Get the custom attribution dialog manager.
    
    Returns:
    
    the active manager class used for showing attribution
  - setAttributionGravity
```
public void setAttributionGravity(int gravity)
```
    Sets the gravity of the attribution.
    By default, the attribution is in the bottom left corner next to the Dingi logo.
    
    Parameters:
    
    gravity - Android SDK Gravity.
  - getAttributionGravity
```
public int getAttributionGravity()
```
    Returns the gravity value of the logo
    
    Returns:
    
    The gravity
  - setAttributionMargins
```
public void setAttributionMargins(int left,
                                  int top,
                                  int right,
                                  int bottom)
```
    Sets the margins of the attribution view.
    
    Parameters:
    
    left - The left margin in pixels.
    
    top - The top margin in pixels.
    
    right - The right margin in pixels.
    
    bottom - The bottom margin in pixels.
  - setAttributionTintColor
```
public void setAttributionTintColor(int tintColor)
```
    Sets the tint of the attribution view. Use this to change the color of the attribution.
    
    Parameters:
    
    tintColor - Color to tint the attribution.
  - getAttributionMarginLeft
```
public int getAttributionMarginLeft()
```
    Returns the left side margin of the attribution view.
    
    Returns:
    
    The left margin in pixels
  - getAttributionMarginTop
```
public int getAttributionMarginTop()
```
    Returns the top side margin of the attribution view.
    
    Returns:
    
    The top margin in pixels
  - getAttributionMarginRight
```
public int getAttributionMarginRight()
```
    Returns the right side margin of the attribution view.
    
    Returns:
    
    The right margin in pixels
  - getAttributionMarginBottom
```
public int getAttributionMarginBottom()
```
    Returns the bottom side margin of the logo
    
    Returns:
    
    The bottom margin in pixels
  - setRotateGesturesEnabled
```
public void setRotateGesturesEnabled(boolean rotateGesturesEnabled)
```
    Changes whether the user may rotate the map.
    
    This setting controls only user interactions with the map. If you set the value to false, you may still change the map location programmatically.
    The default value is true.
    
    Parameters:
    
    rotateGesturesEnabled - If true, rotating is enabled.
  - isRotateGesturesEnabled
```
public boolean isRotateGesturesEnabled()
```
    Returns whether the user may rotate the map.
    
    Returns:
    
    If true, rotating is enabled.
  - setTiltGesturesEnabled
```
public void setTiltGesturesEnabled(boolean tiltGesturesEnabled)
```
    Changes whether the user may tilt the map.
    
    This setting controls only user interactions with the map. If you set the value to false, you may still change the map location programmatically.
    The default value is true.
    
    Parameters:
    
    tiltGesturesEnabled - If true, tilting is enabled.
  - isTiltGesturesEnabled
```
public boolean isTiltGesturesEnabled()
```
    Returns whether the user may tilt the map.
    
    Returns:
    
    If true, tilting is enabled.
  - setZoomGesturesEnabled
```
public void setZoomGesturesEnabled(boolean zoomGesturesEnabled)
```
    Changes whether the user may zoom the map.
    
    This setting controls only user interactions with the map. If you set the value to false, you may still change the map location programmatically.
    The default value is true.
    
    Parameters:
    
    zoomGesturesEnabled - If true, zooming is enabled.
  - isZoomGesturesEnabled
```
public boolean isZoomGesturesEnabled()
```
    Returns whether the user may zoom the map.
    
    Returns:
    
    If true, zooming is enabled.
  - setDoubleTapGesturesEnabled
```
public void setDoubleTapGesturesEnabled(boolean doubleTapGesturesEnabled)
```
    Changes whether the user may zoom the map with a double tap.
    
    This setting controls only user interactions with the map. If you set the value to false, you may still change the map location programmatically.
    The default value is true.
    
    Parameters:
    
    doubleTapGesturesEnabled - If true, zooming with a double tap is enabled.
  - isDoubleTapGesturesEnabled
```
public boolean isDoubleTapGesturesEnabled()
```
    Returns whether the user may zoom the map with a double tap.
    
    Returns:
    
    If true, zooming with a double tap is enabled.
  - isDeselectMarkersOnTap
```
public boolean isDeselectMarkersOnTap()
```
    Gets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.
    
    Returns:
    
    If true, markers are deselected on a map tap.
  - setDeselectMarkersOnTap
```
public void setDeselectMarkersOnTap(boolean deselectMarkersOnTap)
```
    Sets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.
    
    Parameters:
    
    deselectMarkersOnTap - determines if markers should be deslected on tap
  - setScrollGesturesEnabled
```
public void setScrollGesturesEnabled(boolean scrollGesturesEnabled)
```
    Changes whether the user may scroll around the map.
    
    This setting controls only user interactions with the map. If you set the value to false, you may still change the map location programmatically.
    The default value is true.
    
    Parameters:
    
    scrollGesturesEnabled - If true, scrolling is enabled.
  - isScrollGesturesEnabled
```
public boolean isScrollGesturesEnabled()
```
    Returns whether the user may scroll around the map.
    
    Returns:
    
    If true, scrolling is enabled.
  - isScaleVelocityAnimationEnabled
```
public boolean isScaleVelocityAnimationEnabled()
```
    Returns whether scale velocity animation should execute after users finishes a gesture.
    
    Returns:
    
    If true, scale velocity animation is enabled.
  - setScaleVelocityAnimationEnabled
```
public void setScaleVelocityAnimationEnabled(boolean scaleVelocityAnimationEnabled)
```
    Set whether scale velocity animation should execute after users finishes a gesture. True by default.
    
    Parameters:
    
    scaleVelocityAnimationEnabled - If true, scale velocity animation will be enabled.
  - isRotateVelocityAnimationEnabled
```
public boolean isRotateVelocityAnimationEnabled()
```
    Returns whether rotate velocity animation should execute after users finishes a gesture.
    
    Returns:
    
    If true, rotate velocity animation is enabled.
  - setRotateVelocityAnimationEnabled
```
public void setRotateVelocityAnimationEnabled(boolean rotateVelocityAnimationEnabled)
```
    Set whether rotate velocity animation should execute after users finishes a gesture. True by default.
    
    Parameters:
    
    rotateVelocityAnimationEnabled - If true, rotate velocity animation will be enabled.
  - isFlingVelocityAnimationEnabled
```
public boolean isFlingVelocityAnimationEnabled()
```
    Returns whether fling velocity animation should execute after users finishes a gesture.
    
    Returns:
    
    If true, fling velocity animation is enabled.
  - setFlingVelocityAnimationEnabled
```
public void setFlingVelocityAnimationEnabled(boolean flingVelocityAnimationEnabled)
```
    Set whether fling velocity animation should execute after users finishes a gesture. True by default.
    
    Parameters:
    
    flingVelocityAnimationEnabled - If true, fling velocity animation will be enabled.
  - setAllVelocityAnimationsEnabled
```
public void setAllVelocityAnimationsEnabled(boolean allVelocityAnimationsEnabled)
```
    Set whether all velocity animations should execute after users finishes a gesture.
    
    Parameters:
    
    allVelocityAnimationsEnabled - If true, all velocity animations will be enabled.
  - isIncreaseRotateThresholdWhenScaling
```
public boolean isIncreaseRotateThresholdWhenScaling()
```
    Returns whether rotation threshold should be increase whenever scale is detected.
    
    Returns:
    
    If true, rotation threshold will be increased.
  - setIncreaseRotateThresholdWhenScaling
```
public void setIncreaseRotateThresholdWhenScaling(boolean increaseRotateThresholdWhenScaling)
```
    Set whether rotation threshold should be increase whenever scale is detected.
    
    Parameters:
    
    increaseRotateThresholdWhenScaling - If true, rotation threshold will be increased.
  - isIncreaseScaleThresholdWhenRotating
```
public boolean isIncreaseScaleThresholdWhenRotating()
```
    Returns whether scale threshold should be increase whenever rotation is detected.
    
    Returns:
    
    If true, scale threshold will be increased.
  - setIncreaseScaleThresholdWhenRotating
```
public void setIncreaseScaleThresholdWhenRotating(boolean increaseScaleThresholdWhenRotating)
```
    set whether scale threshold should be increase whenever rotation is detected.
    
    Parameters:
    
    increaseScaleThresholdWhenRotating - If true, scale threshold will be increased.
  - setAllGesturesEnabled
```
public void setAllGesturesEnabled(boolean enabled)
```
    Sets the preference for whether all gestures should be enabled or disabled.
    
    This setting controls only user interactions with the map. If you set the value to false, you may still change the map location programmatically.
    The default value is true.
    
    Parameters:
    
    enabled - If true, all gestures are available; otherwise, all gestures are disabled.
    
    See Also:
    
    ), setScrollGesturesEnabled(boolean), setRotateGesturesEnabled(boolean), setTiltGesturesEnabled(boolean)
  - setFocalPoint
```
public void setFocalPoint(@Nullable
                          android.graphics.PointF focalPoint)
```
    Sets the focal point used as center for a gesture
    
    Parameters:
    
    focalPoint - the focal point to be used.
  - getFocalPoint
```
@Nullable
public android.graphics.PointF getFocalPoint()
```
    Returns the gesture focal point
    
    Returns:
    
    The focal point
  - getHeight
```
public float getHeight()
```
    Returns the measured height of the MapView
    
    Returns:
    
    height in pixels
  - getWidth
```
public float getWidth()
```
    Returns the measured width of the MapView
    
    Returns:
    
    widht in pixels
  - invalidate
```
public void invalidate()
```
    Invalidates the ViewSettings instances shown on top of the MapView

Class UiSettings

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setCompassEnabled

isCompassEnabled

setCompassGravity

setCompassFadeFacingNorth

setCompassImage

isCompassFadeWhenFacingNorth

getCompassGravity

setCompassMargins

getCompassMarginLeft

getCompassMarginTop

getCompassMarginRight

getCompassMarginBottom

getCompassImage

setLogoEnabled

isLogoEnabled

setLogoGravity

getLogoGravity

setLogoMargins

getLogoMarginLeft

getLogoMarginTop

getLogoMarginRight

getLogoMarginBottom

setAttributionEnabled

isAttributionEnabled

setAttributionDialogManager

getAttributionDialogManager

setAttributionGravity

getAttributionGravity

setAttributionMargins

setAttributionTintColor

getAttributionMarginLeft

getAttributionMarginTop

getAttributionMarginRight

getAttributionMarginBottom

setRotateGesturesEnabled

isRotateGesturesEnabled

setTiltGesturesEnabled

isTiltGesturesEnabled

setZoomGesturesEnabled

isZoomGesturesEnabled

setDoubleTapGesturesEnabled

isDoubleTapGesturesEnabled

isDeselectMarkersOnTap

setDeselectMarkersOnTap

setScrollGesturesEnabled

isScrollGesturesEnabled

isScaleVelocityAnimationEnabled

setScaleVelocityAnimationEnabled

isRotateVelocityAnimationEnabled

setRotateVelocityAnimationEnabled

isFlingVelocityAnimationEnabled

setFlingVelocityAnimationEnabled

setAllVelocityAnimationsEnabled

isIncreaseRotateThresholdWhenScaling

setIncreaseRotateThresholdWhenScaling

isIncreaseScaleThresholdWhenRotating

setIncreaseScaleThresholdWhenRotating

setAllGesturesEnabled

setFocalPoint

getFocalPoint

getHeight

getWidth

invalidate