GesturesSettingsInterface

Interface that defines the public settings interface for GesturesPlugin.

interface GesturesSettingsInterface

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getSettings
Link copied to clipboard

Get current gestures configuration.

abstract fun getSettings(): GesturesSettings
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String
updateSettings
Link copied to clipboard

Update gestures configuration, the update will be applied to the plugin automatically.

abstract fun updateSettings(block: GesturesSettings.() -> Unit)

Properties

disableRotateWhenScaling
Link copied to clipboard

Whether rotate is disabled when scaling. true by default.

abstract var disableRotateWhenScaling: Boolean
doubleTapToZoomEnabled
Link copied to clipboard

Whether double tapping the map results in a zoom gesture.

abstract var doubleTapToZoomEnabled: Boolean
flingVelocityAnimationEnabled
Link copied to clipboard

Whether fling velocity animations are enabled, true by default.

abstract var flingVelocityAnimationEnabled: Boolean
focalPoint
Link copied to clipboard

Whether a gesture executes around a fixed focal point or the center of the gesture.

abstract var focalPoint: ScreenCoordinate?
increaseRotateThresholdWhenScaling
Link copied to clipboard

Whether rotate threshold increases when scaling. true by default.

abstract var increaseRotateThresholdWhenScaling: Boolean
increaseScaleThresholdWhenRotating
Link copied to clipboard

Whether scale threshold increases when rotating. true by default.

abstract var increaseScaleThresholdWhenRotating: Boolean
panScrollMode
Link copied to clipboard

Whether the user is restricted in which direction the map is scrolled.

abstract var panScrollMode: PanScrollMode
pitchEnabled
Link copied to clipboard

Whether pitch gestures are enabled.

abstract var pitchEnabled: Boolean
pixelRatio
Link copied to clipboard

The pixel ratio of the device that the gestures will take in account.

abstract var pixelRatio: Float
quickZoomEnabled
Link copied to clipboard

Whether quick zoom gesture is enabled.

abstract var quickZoomEnabled: Boolean
rotateEnabled
Link copied to clipboard

Whether rotation gestures are enabled.

abstract var rotateEnabled: Boolean
rotateVelocityAnimationEnabled
Link copied to clipboard

Whether rotate velocity animations are enabled, true by default.

abstract var rotateVelocityAnimationEnabled: Boolean
scaleVelocityAnimationEnabled
Link copied to clipboard

Whether scale velocity animations are enabled, true by default.

abstract var scaleVelocityAnimationEnabled: Boolean
scrollEnabled
Link copied to clipboard

Whether scroll gestures are enabled.

abstract var scrollEnabled: Boolean
zoomEnabled
Link copied to clipboard

Whether zoom gestures are enabled.

abstract var zoomEnabled: Boolean
zoomRate
Link copied to clipboard

The rate at which the zoom level increases. 1.0 by default

abstract var zoomRate: Float

Inheritors

GesturesPlugin
Link copied to clipboard
GesturesSettingsBase
Link copied to clipboard