MapOverlayPlugin

interface MapOverlayPlugin : MapSizePlugin, MapPlugin

Interface for MapOverlay Container that manage MapOverlays.

Functions

cleanup
Link copied to clipboard
open fun cleanup()

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

getEdgeInsets
Link copied to clipboard
abstract fun getEdgeInsets(): EdgeInsets

Get an EdgeInsets that represent the width and height of overlays

initialize
Link copied to clipboard
open fun initialize()

Called when the plugin is first added to the map.

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

Provides all map delegate instances.

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

Invoked when MapView's width and height have changed.

reframe
Link copied to clipboard
abstract fun reframe(onReframeFinished: OnReframeFinished? = null)

Reframe MapView to a certain zoom and position to make sure every coordinate will be shown on the MapView and not covered by registered MapOverlays. If no OnReframeFinished object is provided, MapView will jump to the new CameraOptions directly; if OnReframeFinished object is provided, the new CameraOptions will be return and users can define their own animation to move the camera.

registerMapOverlayCoordinatesProvider
Link copied to clipboard
abstract fun registerMapOverlayCoordinatesProvider(provider: MapOverlayCoordinatesProvider)

To register a MapOverlayCoordinatesProvider instance to the Container

registerOverlay
Link copied to clipboard
abstract fun registerOverlay(overlay: View)

Register an view as overlay.

registerOverlays
Link copied to clipboard
abstract fun registerOverlays(overlays: List<View>)

Register views as overlays

setDisplayingAreaMargins
Link copied to clipboard
abstract fun setDisplayingAreaMargins(marginTop: Int, marginLeft: Int, marginBottom: Int, marginRight: Int)

Set the margins for the area that displaying import POIs without covered. These margins can let the POIs near the border not by cut or covered.

unregisterMapOverlayCoordinatesProvider
Link copied to clipboard
abstract fun unregisterMapOverlayCoordinatesProvider()
unregisterOverlay
Link copied to clipboard
abstract fun unregisterOverlay(overlay: View)

Unregister an view.

unregisterOverlays
Link copied to clipboard
abstract fun unregisterOverlays(overlays: List<View>)

Unregister views.

Inheritors

MapOverlayPluginImpl
Link copied to clipboard