mapbox-maps-android/com.mapbox.maps.plugin.overlay/MapOverlayPlugin

MapOverlayPlugin

Interface for MapOverlay Container that manage MapOverlays.

interface MapOverlayPlugin : MapSizePlugin, MapPlugin

Functions

cleanup

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

open override fun cleanup()

equals

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

getEdgeInsets

Get an EdgeInsets that represent the width and height of overlays

abstract fun getEdgeInsets(): EdgeInsets

hashCode

open override fun hashCode(): Int

initialize

Called when the plugin is first added to the map.

open override fun initialize()

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onSizeChanged

Invoked when MapView's width and height have changed.

open override fun onSizeChanged(width: Int, height: Int)

reframe

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.

abstract fun reframe(onReframeFinished: OnReframeFinished?)

registerMapOverlayCoordinatesProvider

To register a MapOverlayCoordinatesProvider instance to the Container

abstract fun registerMapOverlayCoordinatesProvider(provider: MapOverlayCoordinatesProvider)

registerOverlay

abstract fun registerOverlay(overlay: View)

registerOverlays

abstract fun registerOverlays(overlays: List<View>)

setDisplayingAreaMargins

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.

abstract fun setDisplayingAreaMargins(marginTop: Int, marginLeft: Int, marginBottom: Int, marginRight: Int)

toString

open override fun toString(): String

unregisterMapOverlayCoordinatesProvider

Unregister the MapOverlayCoordinatesProvider.

abstract fun unregisterMapOverlayCoordinatesProvider()

unregisterOverlay

Unregister an view.

abstract fun unregisterOverlay(overlay: View)

unregisterOverlays

Unregister views.

abstract fun unregisterOverlays(overlays: List<View>)

Inheritors

MapOverlayPluginImpl