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

MapOverlayPlugin

interface MapOverlayPlugin : MapSizePlugin, MapPlugin

Interface for MapOverlay Container that manage MapOverlays.

Functions

cleanup

open fun cleanup()

Called when the map is destroyed.

equals

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

getEdgeInsets

abstract fun getEdgeInsets(): EdgeInsets

Get an EdgeInsets that represent the width and height of overlays

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onSizeChanged

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

Invoked when MapView's width and height have changed.

reframe

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.

registerMapOverlayCoordinatesProvider

abstract fun registerMapOverlayCoordinatesProvider(provider: MapOverlayCoordinatesProvider)

To register a MapOverlayCoordinatesProvider instance to the Container

registerOverlay

abstract fun registerOverlay(overlay: View)

registerOverlays

abstract fun registerOverlays(overlays: List<View>)

setDisplayingAreaMargins

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

Set the margins for the area that displaying import POIs without covered.

toString

open fun toString(): String

unregisterMapOverlayCoordinatesProvider

abstract fun unregisterMapOverlayCoordinatesProvider()

Unregister the MapOverlayCoordinatesProvider.

unregisterOverlay

abstract fun unregisterOverlay(overlay: View)

Unregister an view.

unregisterOverlays

abstract fun unregisterOverlays(overlays: List<View>)

Unregister views.

Inheritors

MapOverlayPluginImpl