MapLibre Native Android/org.maplibre.android.maps/UiSettings

UiSettings

class UiSettings

Settings for the user interface of a MapLibreMap. To obtain this interface, call getUiSettings().

Properties

attributionDialogManager

@get:Nullable

open var attributionDialogManager: AttributionDialogManager

flingAnimationBaseTime

open var flingAnimationBaseTime: Long

flingThreshold

open var flingThreshold: Long

zoomRate

open var zoomRate: Float

Functions

areAllGesturesEnabled

open fun areAllGesturesEnabled(): Boolean

Retrieves the current status of whether all gestures are enabled.

getAttributionGravity

open fun getAttributionGravity(): Int

Returns the gravity value of the logo

getAttributionMarginBottom

@Px

open fun getAttributionMarginBottom(): Int

Returns the bottom side margin of the logo in pixels.

getAttributionMarginLeft

@Px

open fun getAttributionMarginLeft(): Int

Returns the left side margin of the attribution view in pixels.

getAttributionMarginRight

@Px

open fun getAttributionMarginRight(): Int

Returns the right side margin of the attribution view in pixels.

getAttributionMarginTop

@Px

open fun getAttributionMarginTop(): Int

Returns the top side margin of the attribution view in pixels.

getCompassGravity

open fun getCompassGravity(): Int

Returns the gravity value of the CompassView

getCompassImage

@Nullable

open fun getCompassImage(): Drawable

Get the current configured CompassView image.

getCompassMarginBottom

@Px

open fun getCompassMarginBottom(): Int

Returns the bottom side margin of CompassView in pixels.

getCompassMarginLeft

@Px

open fun getCompassMarginLeft(): Int

Returns the left side margin of CompassView in pixels.

getCompassMarginRight

@Px

open fun getCompassMarginRight(): Int

Returns the right side margin of CompassView in pixels.

getCompassMarginTop

@Px

open fun getCompassMarginTop(): Int

Returns the top side margin of CompassView in pixels.

getFocalPoint

@Nullable

open fun getFocalPoint(): PointF

Returns the gesture focal point

getHeight

open fun getHeight(): Float

Returns the measured height of the MapView

getLogoGravity

open fun getLogoGravity(): Int

Returns the gravity value of the logo

getLogoMarginBottom

@Px

open fun getLogoMarginBottom(): Int

Returns the bottom side margin of the logo in pixels.

getLogoMarginLeft

@Px

open fun getLogoMarginLeft(): Int

Returns the left side margin of the logo in pixels.

getLogoMarginRight

@Px

open fun getLogoMarginRight(): Int

Returns the right side margin of the logo in pixels.

getLogoMarginTop

@Px

open fun getLogoMarginTop(): Int

Returns the top side margin of the logo in pixels.

getWidth

open fun getWidth(): Float

Returns the measured width of the MapView

invalidate

open fun invalidate()

Invalidates the ViewSettings instances shown on top of the MapView

isAttributionEnabled

open fun isAttributionEnabled(): Boolean

Returns whether the attribution is enabled.

isCompassEnabled

open fun isCompassEnabled(): Boolean

Returns whether the compass is enabled.

isCompassFadeWhenFacingNorth

open fun isCompassFadeWhenFacingNorth(): Boolean

Returns whether the compass performs a fading animation out when facing north.

isDeselectMarkersOnTap

open fun isDeselectMarkersOnTap(): Boolean

Gets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.

isDisableRotateWhenScaling

open fun isDisableRotateWhenScaling(): Boolean

Returns whether rotation gesture detector is disabled when scale is detected first.

isDoubleTapGesturesEnabled

open fun isDoubleTapGesturesEnabled(): Boolean

Returns whether the user may zoom the map with a double tap.

isFlingVelocityAnimationEnabled

open fun isFlingVelocityAnimationEnabled(): Boolean

Returns whether fling velocity animation should execute after users finishes a gesture.

isHorizontalScrollGesturesEnabled

open fun isHorizontalScrollGesturesEnabled(): Boolean

Returns whether the user may scroll horizontally around the map.

isIncreaseRotateThresholdWhenScaling

open fun ~~isIncreaseRotateThresholdWhenScaling~~(): Boolean

Returns whether rotation threshold should be increase whenever scale is detected.

isIncreaseScaleThresholdWhenRotating

open fun isIncreaseScaleThresholdWhenRotating(): Boolean

Returns whether scale threshold should be increase whenever rotation is detected.

isLogoEnabled

open fun isLogoEnabled(): Boolean

Returns whether the logo is enabled.

isQuickZoomGesturesEnabled

open fun isQuickZoomGesturesEnabled(): Boolean

Returns whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.

isRotateGesturesEnabled

open fun isRotateGesturesEnabled(): Boolean

Returns whether the user may rotate the map.

isRotateVelocityAnimationEnabled

open fun isRotateVelocityAnimationEnabled(): Boolean

Returns whether rotate velocity animation should execute after users finishes a gesture.

isScaleVelocityAnimationEnabled

open fun isScaleVelocityAnimationEnabled(): Boolean

Returns whether scale velocity animation should execute after users finishes a gesture.

isScrollGesturesEnabled

open fun isScrollGesturesEnabled(): Boolean

Returns whether the user may scroll around the map.

isTiltGesturesEnabled

open fun isTiltGesturesEnabled(): Boolean

Returns whether the user may tilt the map.

isZoomGesturesEnabled

open fun isZoomGesturesEnabled(): Boolean

Returns whether the user may zoom the map.

setAllGesturesEnabled

open fun setAllGesturesEnabled(enabled: Boolean)

Sets the preference for whether all gestures should be enabled or disabled.

setAllVelocityAnimationsEnabled

open fun setAllVelocityAnimationsEnabled(allVelocityAnimationsEnabled: Boolean)

Set whether all velocity animations should execute after users finishes a gesture.

setAttributionEnabled

open fun setAttributionEnabled(enabled: Boolean)

Enables or disables the attribution.

setAttributionGravity

open fun setAttributionGravity(gravity: Int)

Sets the gravity of the attribution.

setAttributionMargins

open fun setAttributionMargins(@Px left: Int, @Px top: Int, @Px right: Int, @Px bottom: Int)

Sets the margins of the attribution view in pixels.

setAttributionTintColor

open fun setAttributionTintColor(@ColorInt tintColor: Int)

Sets the tint of the attribution view.

setCompassEnabled

open fun setCompassEnabled(compassEnabled: Boolean)

Enables or disables the compass.

setCompassFadeFacingNorth

open fun setCompassFadeFacingNorth(compassFadeFacingNorth: Boolean)

Enables or disables fading of the compass when facing north.

setCompassGravity

@UiThread

open fun setCompassGravity(gravity: Int)

Sets the gravity of the compass view.

setCompassImage

open fun setCompassImage(@NonNull compass: Drawable)

Specifies the CompassView image.

setCompassMargins

@UiThread

open fun setCompassMargins(@Px left: Int, @Px top: Int, @Px right: Int, @Px bottom: Int)

Sets the margins of the compass view in pixels.

setDeselectMarkersOnTap

open fun setDeselectMarkersOnTap(deselectMarkersOnTap: Boolean)

Sets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.

setDisableRotateWhenScaling

open fun setDisableRotateWhenScaling(disableRotateWhenScaling: Boolean)

Set whether rotation gesture detector should be disabled when scale is detected first.

setDoubleTapGesturesEnabled

open fun setDoubleTapGesturesEnabled(doubleTapGesturesEnabled: Boolean)

Changes whether the user may zoom the map with a double tap.

setFlingVelocityAnimationEnabled

open fun setFlingVelocityAnimationEnabled(flingVelocityAnimationEnabled: Boolean)

Set whether fling velocity animation should execute after users finishes a gesture.

setFocalPoint

open fun setFocalPoint(@Nullable focalPoint: PointF)

Sets the focal point used as center for a gesture

setHorizontalScrollGesturesEnabled

open fun setHorizontalScrollGesturesEnabled(horizontalScrollGesturesEnabled: Boolean)

Changes whether the user may scroll horizontally around the map.

setIncreaseRotateThresholdWhenScaling

open fun ~~setIncreaseRotateThresholdWhenScaling~~(increaseRotateThresholdWhenScaling: Boolean)

Set whether rotation threshold should be increase whenever scale is detected.

setIncreaseScaleThresholdWhenRotating

open fun setIncreaseScaleThresholdWhenRotating(increaseScaleThresholdWhenRotating: Boolean)

set whether scale threshold should be increase whenever rotation is detected.

setLogoEnabled

open fun setLogoEnabled(enabled: Boolean)

Enables or disables the MapLibre logo.

setLogoGravity

open fun setLogoGravity(gravity: Int)

Sets the gravity of the logo view.

setLogoMargins

open fun setLogoMargins(@Px left: Int, @Px top: Int, @Px right: Int, @Px bottom: Int)

Sets the margins of the logo view in pixels.

setQuickZoomGesturesEnabled

open fun setQuickZoomGesturesEnabled(quickZoomGesturesEnabled: Boolean)

Changes whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.

setRotateGesturesEnabled

open fun setRotateGesturesEnabled(rotateGesturesEnabled: Boolean)

Changes whether the user may rotate the map.

setRotateVelocityAnimationEnabled

open fun setRotateVelocityAnimationEnabled(rotateVelocityAnimationEnabled: Boolean)

Set whether rotate velocity animation should execute after users finishes a gesture.

setScaleVelocityAnimationEnabled

open fun setScaleVelocityAnimationEnabled(scaleVelocityAnimationEnabled: Boolean)

Set whether scale velocity animation should execute after users finishes a gesture.

setScrollGesturesEnabled

open fun setScrollGesturesEnabled(scrollGesturesEnabled: Boolean)

Changes whether the user may scroll around the map.

setTiltGesturesEnabled

open fun setTiltGesturesEnabled(tiltGesturesEnabled: Boolean)

Changes whether the user may tilt the map.

setZoomGesturesEnabled

open fun setZoomGesturesEnabled(zoomGesturesEnabled: Boolean)

Changes whether the user may zoom the map.