mapbox-maps-android/com.mapbox.maps/MapSurface

MapSurface

class MapSurface : MapPluginProviderDelegate, MapControllable

A MapSurface provides an embeddable map interface. You use this class to display map information and to manipulate the map contents from your application. You can center the map on a given coordinate, specify the size of the area you want to display, and style the features of the map to fit your application's use case.

Use of MapSurface requires a Mapbox API access token. Obtain an access token on the Mapbox account page.

Warning: Please note that you are responsible for getting permission to use the map data, and for ensuring your use adheres to the relevant terms of use.

Constructors

fun MapSurface(context: Context, surface: Surface, mapInitOptions: MapInitOptions = MapInitOptions(context))

Functions

addRendererSetupErrorListener

open override fun addRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Add an instance of RendererSetupErrorListener.

@MapboxExperimental

open override fun addWidget(widget: Widget)

Add Widget to the map.

@JvmName(name = "getMapboxMapDeprecated")

fun ~~getMapboxMap~~(): MapboxMap

Returns a MapboxMap object that can be used to interact with the map.

open override fun <T : MapPlugin> getPlugin(id: String): T?

Get the plugin instance.

open override fun onDestroy()

Called to dispose the renderer

onGenericMotionEvent

open override fun onGenericMotionEvent(event: MotionEvent): Boolean

Called when a motion event has occurred.

open override fun onLowMemory()

Called to reduce memory use

open override fun onSizeChanged(w: Int, h: Int)

Called when the size has changed.

open override fun onStart()

Called to resume rendering

open override fun onStop()

Called to stop rendering

open override fun onTouchEvent(event: MotionEvent): Boolean

Called when a touch event has occurred.

open override fun queueEvent(event: Runnable, needRender: Boolean)

Queue a runnable to be executed on the map renderer thread. Consecutive events will be called in the order they were queued.

removeRendererSetupErrorListener

open override fun removeRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Remove an instance of RendererSetupErrorListener.

@MapboxExperimental

open override fun removeWidget(widget: Widget): Boolean

Remove Widget from the map.

open override fun setMaximumFps(fps: Int)

Called to limit the maximum fps

setOnFpsChangedListener

open override fun setOnFpsChangedListener(listener: OnFpsChangedListener)

Set OnFpsChangedListener to get map rendering FPS.

open override fun snapshot(): Bitmap?

Called to capture a snapshot synchronously.

open override fun snapshot(listener: MapView.OnSnapshotReady)

Called to capture a snapshot asynchronously. Consecutive requests will return snapshots in the order they were added.

fun surfaceChanged(width: Int, height: Int)

Must be called when the surface dimensions have changed.

fun surfaceCreated()

Must be called when the surface has been created.

surfaceDestroyed

fun surfaceDestroyed()

Must be called when the surface is destroyed.

Properties

open override val mapboxMap: MapboxMap

Returns a MapboxMap object that can be used to interact with the map.

val surface: Surface

The surface to be used, set from the constructor.

Extensions

@get:JvmName(name = "getAnnotations")

val MapPluginProviderDelegate.annotations: AnnotationPlugin

Extension val for MapView to get the Annotation plugin instance.

@get:JvmName(name = "getAttribution")

val MapPluginProviderDelegate.attribution: AttributionPlugin

Extension val for MapView to get the Compass View plugin instance.

@get:JvmName(name = "getCamera")

val MapPluginProviderDelegate.camera: CameraAnimationsPlugin

Extension val for MapView to get the Camera Animations plugin instance.

@get:JvmName(name = "getCompass")

val MapPluginProviderDelegate.compass: CompassPlugin

Extension val for MapView to get the Compass View plugin instance.

@get:JvmName(name = "getGestures")

val MapPluginProviderDelegate.gestures: GesturesPlugin

Extension val for MapView to get the Gestures plugin instance.

@get:JvmName(name = "getLifecycle")

val MapPluginProviderDelegate.lifecycle: MapboxLifecyclePlugin

Extension function for MapView to get the lifecycle plugin instance.

@get:JvmName(name = "getLocationComponent")

val MapPluginProviderDelegate.location: LocationComponentPlugin

Extension val to get the LocationComponentPlugin instance.

@get:JvmName(name = "getLogo")

val MapPluginProviderDelegate.logo: LogoPlugin

Extension val for MapView to get the Logo View plugin instance.

@get:JvmName(name = "getOverlay")

val MapPluginProviderDelegate.mapboxOverlay: MapOverlayPlugin

Extension val for MapView to get the map overlay plugin instance.

@get:JvmName(name = "getScaleBar")

val MapPluginProviderDelegate.scalebar: ScaleBarPlugin

Extension val for MapView to get the ScaleBar plugin instance.