mapbox-maps-android/com.mapbox.maps.plugin.gestures

Package com.mapbox.maps.plugin.gestures

Types

GesturesPlugin
Link copied to clipboard

Define the interfaces for the Layer plugin.

interface GesturesPlugin : MapPlugin, ContextBinder, MapSizePlugin, GesturesSettingsInterface
Content copied to clipboard
GesturesPluginImpl
Link copied to clipboard

Manages gestures events on a MapView.

class GesturesPluginImpl : GesturesSettingsBase, GesturesPlugin
Content copied to clipboard
OnFlingListener
Link copied to clipboard

Interface definition for a callback to be invoked when the map is flinged.

fun fun interface OnFlingListener
Content copied to clipboard
OnMapClickListener
Link copied to clipboard

Interface definition for a callback to be invoked when the user clicks on the map view.

fun fun interface OnMapClickListener
Content copied to clipboard
OnMapLongClickListener
Link copied to clipboard

Interface definition for a callback to be invoked when the user long clicks on the map view.

fun fun interface OnMapLongClickListener
Content copied to clipboard
OnMoveListener
Link copied to clipboard

Interface definition for a callback to be invoked when the map is moved.

interface OnMoveListener
Content copied to clipboard
OnRotateListener
Link copied to clipboard

Interface definition for a callback to be invoked when the map is rotated.

interface OnRotateListener
Content copied to clipboard
OnScaleListener
Link copied to clipboard

Interface definition for a callback to be invoked when the map is scaled.

interface OnScaleListener
Content copied to clipboard
OnShoveListener
Link copied to clipboard

Interface definition for a callback to be invoked when the map is shoved with two fingers.

interface OnShoveListener
Content copied to clipboard

Functions

addOnFlingListener
Link copied to clipboard

Add a callback that is invoked when the map is has received a fling gesture. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnFlingListener(onFlingListener: OnFlingListener)
Content copied to clipboard
addOnMapClickListener
Link copied to clipboard

Add a callback that is invoked when the map is clicked. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnMapClickListener(onMapClickListener: OnMapClickListener)
Content copied to clipboard
addOnMapLongClickListener
Link copied to clipboard

Add a callback that is invoked when the map is long clicked. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)
Content copied to clipboard
addOnMoveListener
Link copied to clipboard

Add a callback that is invoked when the map is moved. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnMoveListener(listener: OnMoveListener)
Content copied to clipboard
addOnRotateListener
Link copied to clipboard

Add a callback that is invoked when the map is rotated. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnRotateListener(listener: OnRotateListener)
Content copied to clipboard
addOnScaleListener
Link copied to clipboard

Add a callback that is invoked when the map is scaled. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnScaleListener(listener: OnScaleListener)
Content copied to clipboard
addOnShoveListener
Link copied to clipboard

Add a callback that is invoked when the map is shoved. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.addOnShoveListener(listener: OnShoveListener)
Content copied to clipboard
getGesturesManager
Link copied to clipboard

Get the current configured AndroidGesturesManager. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.getGesturesManager(): AndroidGesturesManager?
Content copied to clipboard
getGesturesSettings
Link copied to clipboard

The gesture configuration object. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.getGesturesSettings(): GesturesSettings?
Content copied to clipboard
isScrollHorizontallyLimited
Link copied to clipboard

Returns if the scroll is horizontally limited, In other words, the scroll mode is set to vertical.

fun GesturesSettings.isScrollHorizontallyLimited(): Boolean
Content copied to clipboard
isScrollVerticallyLimited
Link copied to clipboard

Returns if the scroll is vertically limited, In other words, the scroll mode is set to horizontal.

fun GesturesSettings.isScrollVerticallyLimited(): Boolean
Content copied to clipboard
removeOnFlingListener
Link copied to clipboard

Remove a callback that is invoked when the map is has received a fling gesture. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnFlingListener(onFlingListener: OnFlingListener)
Content copied to clipboard
removeOnMapClickListener
Link copied to clipboard

Remove a callback that is invoked when the map is clicked. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnMapClickListener(onMapClickListener: OnMapClickListener)
Content copied to clipboard
removeOnMapLongClickListener
Link copied to clipboard

Remove a callback that is invoked when the map is long clicked. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)
Content copied to clipboard
removeOnMoveListener
Link copied to clipboard

Remove a callback that is invoked when the map is moved. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnMoveListener(listener: OnMoveListener)
Content copied to clipboard
removeOnRotateListener
Link copied to clipboard

Remove a callback that is invoked when the map is rotated. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnRotateListener(listener: OnRotateListener)
Content copied to clipboard
removeOnScaleListener
Link copied to clipboard

Remove a callback that is invoked when the map is scaled. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnScaleListener(listener: OnScaleListener)
Content copied to clipboard
removeOnShoveListener
Link copied to clipboard

Remove a callback that is invoked when the map is shoved. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.removeOnShoveListener(listener: OnShoveListener)
Content copied to clipboard
setGesturesManager
Link copied to clipboard

Set the AndroidGesturesManager instance. Gesture plugin with id = Plugin.MAPBOX_GESTURES_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

fun MapPluginExtensionsDelegate.setGesturesManager(androidGesturesManager: AndroidGesturesManager, attachDefaultListeners: Boolean, setDefaultMutuallyExclusives: Boolean)
Content copied to clipboard

Properties

gestures
Link copied to clipboard

Extension val for MapView to get the Gestures plugin instance.

val MapPluginProviderDelegate.gestures: GesturesPlugin
Content copied to clipboard
© 2020 CopyrightSponsored and developed by dokka