mapbox-maps-android/com.mapbox.maps.plugin.delegates/MapPluginExtensionsDelegate

MapPluginExtensionsDelegate

Definition of the map plugin extensions delegate. Makes possible to call plugin functions directly from MapboxMap.

interface MapPluginExtensionsDelegate

Functions

cameraAnimationsPlugin

Call extension function on CameraAnimationsPlugin. In most cases should not be called directly.

abstract fun cameraAnimationsPlugin(function: CameraAnimationsPlugin.() -> Any?): Any?

equals

open operator override fun equals(other: Any?): Boolean

gesturesPlugin

Call extension function on GesturesPlugin. In most cases should not be called directly.

abstract fun gesturesPlugin(function: GesturesPlugin.() -> Any?): Any?

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Inheritors

MapboxMap

Extensions

addOnFlingListener

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)

addOnMapClickListener

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)

addOnMapLongClickListener

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)

addOnMoveListener

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)

addOnRotateListener

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)

addOnScaleListener

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)

addOnShoveListener

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)

easeTo

Extension easeTo() for MapPluginExtensionsDelegate Ease the map camera to a given camera options and animation options

Camera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

@JvmOverloads()

fun MapPluginExtensionsDelegate.easeTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?): Cancelable

flyTo

Extension flyTo() function for MapPluginExtensionsDelegate Fly the map camera to a given camera options.

Camera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

@JvmOverloads()

fun MapPluginExtensionsDelegate.flyTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?): Cancelable

getGesturesManager

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?

getGesturesSettings

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?

moveBy

Extension moveBy() function for MapPluginExtensionsDelegate Move the map by a given screen coordinate with optional animation.

Camera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

@JvmOverloads()

fun MapPluginExtensionsDelegate.moveBy(screenCoordinate: ScreenCoordinate, animationOptions: MapAnimationOptions?): Cancelable

pitchBy

Extension pitchBy() function for MapPluginExtensionsDelegate Pitch the map by with optional animation.

Camera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

@JvmOverloads()

fun MapPluginExtensionsDelegate.pitchBy(pitch: Double, animationOptions: MapAnimationOptions?): Cancelable

removeOnFlingListener

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)

removeOnMapClickListener

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)

removeOnMapLongClickListener

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)

removeOnMoveListener

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)

removeOnRotateListener

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)

removeOnScaleListener

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)

removeOnShoveListener

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)

rotateBy

Extension rotateBy() function for MapPluginExtensionsDelegate Rotate the map by with optional animation.

Camera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

@JvmOverloads()

fun MapPluginExtensionsDelegate.rotateBy(first: ScreenCoordinate, second: ScreenCoordinate, animationOptions: MapAnimationOptions?): Cancelable

scaleBy

Extension scaleBy() function for MapPluginExtensionsDelegate Scale the map by with optional animation.

Camera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.MapView as part of com.mapbox.maps.MapInitOptions.plugins.

@JvmOverloads()

fun MapPluginExtensionsDelegate.scaleBy(amount: Double, screenCoordinate: ScreenCoordinate?, animationOptions: MapAnimationOptions?): Cancelable

setGesturesManager

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)