AnnotationPlugin

interface AnnotationPlugin : MapPlugin, MapSizePlugin, MapStyleObserverPlugin
Content copied to clipboard

Plugin interface for the annotation.

Functions

cleanup
Link copied to clipboard
open fun cleanup()
Content copied to clipboard

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

createAnnotationManager
Link copied to clipboard
abstract fun createAnnotationManager(type: AnnotationType, annotationConfig: AnnotationConfig?): AnnotationManager<*, *, *, *, *, *, *>
Content copied to clipboard
abstract fun createAnnotationManager(mapView: View, type: AnnotationType, annotationConfig: AnnotationConfig?): AnnotationManager<*, *, *, *, *, *, *>
Content copied to clipboard

Create an annotation manager.

initialize
Link copied to clipboard
open fun initialize()
Content copied to clipboard

Called when the plugin is first added to the map.

onDelegateProvider
Link copied to clipboard
open fun onDelegateProvider(delegateProvider: MapDelegateProvider)
Content copied to clipboard

Provides all map delegate instances.

onSizeChanged
Link copied to clipboard
open fun onSizeChanged(width: Int, height: Int)
Content copied to clipboard

Invoked when MapView's width and height have changed.

onStyleChanged
Link copied to clipboard
abstract fun onStyleChanged(styleDelegate: StyleInterface)
Content copied to clipboard

Called when a new Style is loaded.

removeAnnotationManager
Link copied to clipboard
abstract fun removeAnnotationManager(annotationManager: AnnotationManager<*, *, *, *, *, *, *>)
Content copied to clipboard

Removes an annotation manager, this will remove the underlying layer and source from the style. A removed annotation manager will not be able to reuse anymore, users need to create new annotation manager to add annotations.

Inheritors

AnnotationPluginImpl
Link copied to clipboard

Extensions

createCircleAnnotationManager
Link copied to clipboard
@JvmOverloads
fun AnnotationPlugin.createCircleAnnotationManager(mapView: View, annotationConfig: AnnotationConfig? = null): CircleAnnotationManager
Content copied to clipboard
fun AnnotationPlugin.createCircleAnnotationManager(annotationConfig: AnnotationConfig? = null): CircleAnnotationManager
Content copied to clipboard

Extension function to create a CircleAnnotationManager instance.

createPointAnnotationManager
Link copied to clipboard
@JvmOverloads
fun AnnotationPlugin.createPointAnnotationManager(mapView: View, annotationConfig: AnnotationConfig? = null): PointAnnotationManager
Content copied to clipboard
fun AnnotationPlugin.createPointAnnotationManager(annotationConfig: AnnotationConfig? = null): PointAnnotationManager
Content copied to clipboard

Extension function to create a PointAnnotationManager instance.

createPolygonAnnotationManager
Link copied to clipboard
@JvmOverloads
fun AnnotationPlugin.createPolygonAnnotationManager(mapView: View, annotationConfig: AnnotationConfig? = null): PolygonAnnotationManager
Content copied to clipboard
fun AnnotationPlugin.createPolygonAnnotationManager(annotationConfig: AnnotationConfig? = null): PolygonAnnotationManager
Content copied to clipboard

Extension function to create a PolygonAnnotationManager instance.

createPolylineAnnotationManager
Link copied to clipboard
@JvmOverloads
fun AnnotationPlugin.createPolylineAnnotationManager(mapView: View, annotationConfig: AnnotationConfig? = null): PolylineAnnotationManager
Content copied to clipboard
fun AnnotationPlugin.createPolylineAnnotationManager(annotationConfig: AnnotationConfig? = null): PolylineAnnotationManager
Content copied to clipboard

Extension function to create a PolylineAnnotationManager instance.