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

MapOverlayPlugin

interface MapOverlayPlugin : MapSizePlugin, MapPlugin

Interface for MapOverlay Container that manage MapOverlays.

Functions

Link copied to clipboard
open fun cleanup()

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

Link copied to clipboard
abstract fun getEdgeInsets(): EdgeInsets

Get an EdgeInsets that represent the width and height of overlays

Link copied to clipboard
open fun initialize()

Called when the plugin is first added to the map.

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

Provides all map delegate instances.

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

Invoked when MapView's width and height have changed.

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 be 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.

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

To register a MapOverlayCoordinatesProvider instance to the Container

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

Register a view as overlay.

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

Register views as overlays

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

Set the margins for the area that is displaying POIs within the overlay bounds. These margins provide offsets to ensure POIs near the border of the overlay not be hidden or covered.

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

Unregister a view.

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

Unregister views.