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

MapPluginExtensionsDelegate

interface MapPluginExtensionsDelegate

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

Functions

cameraAnimationsPlugin

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

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

gesturesPlugin

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

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

Inheritors

MapboxMap

Extensions

addOnFlingListener

fun MapPluginExtensionsDelegate.addOnFlingListener(onFlingListener: OnFlingListener)

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 MapView as part of MapInitOptions.plugins.

addOnMapClickListener

fun MapPluginExtensionsDelegate.addOnMapClickListener(onMapClickListener: OnMapClickListener)

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 MapView as part of MapInitOptions.plugins.

addOnMapLongClickListener

fun MapPluginExtensionsDelegate.addOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

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 MapView as part of MapInitOptions.plugins.

addOnMoveListener

fun MapPluginExtensionsDelegate.addOnMoveListener(listener: OnMoveListener)

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 MapView as part of MapInitOptions.plugins.

addOnRotateListener

fun MapPluginExtensionsDelegate.addOnRotateListener(listener: OnRotateListener)

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 MapView as part of MapInitOptions.plugins.

addOnScaleListener

fun MapPluginExtensionsDelegate.addOnScaleListener(listener: OnScaleListener)

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 MapView as part of MapInitOptions.plugins.

addOnShoveListener

fun MapPluginExtensionsDelegate.addOnShoveListener(listener: OnShoveListener)

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 MapView as part of MapInitOptions.plugins.

easeTo

@JvmOverloads

fun MapPluginExtensionsDelegate.easeTo( cameraOptions: CameraOptions, animationOptions: MapAnimationOptions? = null, animatorListener: Animator.AnimatorListener? = null): Cancelable

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

flyTo

@JvmOverloads

fun MapPluginExtensionsDelegate.flyTo( cameraOptions: CameraOptions, animationOptions: MapAnimationOptions? = null, animatorListener: Animator.AnimatorListener? = null): Cancelable

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

getGesturesManager

fun MapPluginExtensionsDelegate.getGesturesManager(): AndroidGesturesManager?

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

moveBy

@JvmOverloads

fun MapPluginExtensionsDelegate.moveBy( screenCoordinate: ScreenCoordinate, animationOptions: MapAnimationOptions? = null, animatorListener: Animator.AnimatorListener? = null): Cancelable

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

pitchBy

@JvmOverloads

fun MapPluginExtensionsDelegate.pitchBy( pitch: Double, animationOptions: MapAnimationOptions? = null, animatorListener: Animator.AnimatorListener? = null): Cancelable

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

removeOnFlingListener

fun MapPluginExtensionsDelegate.removeOnFlingListener(onFlingListener: OnFlingListener)

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 MapView as part of MapInitOptions.plugins.

removeOnMapClickListener

fun MapPluginExtensionsDelegate.removeOnMapClickListener(onMapClickListener: OnMapClickListener)

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 MapView as part of MapInitOptions.plugins.

removeOnMapLongClickListener

fun MapPluginExtensionsDelegate.removeOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

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 MapView as part of MapInitOptions.plugins.

removeOnMoveListener

fun MapPluginExtensionsDelegate.removeOnMoveListener(listener: OnMoveListener)

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 MapView as part of MapInitOptions.plugins.

removeOnRotateListener

fun MapPluginExtensionsDelegate.removeOnRotateListener(listener: OnRotateListener)

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 MapView as part of MapInitOptions.plugins.

removeOnScaleListener

fun MapPluginExtensionsDelegate.removeOnScaleListener(listener: OnScaleListener)

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 MapView as part of MapInitOptions.plugins.

removeOnShoveListener

fun MapPluginExtensionsDelegate.removeOnShoveListener(listener: OnShoveListener)

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 MapView as part of MapInitOptions.plugins.

rotateBy

@JvmOverloads

fun MapPluginExtensionsDelegate.rotateBy( first: ScreenCoordinate, second: ScreenCoordinate, animationOptions: MapAnimationOptions? = null, animatorListener: Animator.AnimatorListener? = null): Cancelable

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

scaleBy

@JvmOverloads

fun MapPluginExtensionsDelegate.scaleBy( amount: Double, screenCoordinate: ScreenCoordinate?, animationOptions: MapAnimationOptions? = null, animatorListener: Animator.AnimatorListener? = null): Cancelable

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

setGesturesManager

fun MapPluginExtensionsDelegate.setGesturesManager( androidGesturesManager: AndroidGesturesManager, attachDefaultListeners: Boolean, setDefaultMutuallyExclusives: Boolean)

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