MapSurface

class MapSurface @JvmOverloads constructor(context: Context, surface: Surface, mapInitOptions: MapInitOptions) : 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.

Parameters

context

the application context to init the default MapInitOptions

surface

the surface that will display map

mapInitOptions

the init options to for map

Constructors

MapSurface

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

Functions

addRendererSetupErrorListener

open override fun addRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Add an instance of RendererSetupErrorListener.

addWidget

open override fun addWidget(widget: Widget)

Add Widget to the map.

getMapboxMap

open override fun getMapboxMap(): MapboxMap

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

getPlugin

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

Get the plugin instance.

onDestroy

open override fun onDestroy()

Called to dispose the renderer

onGenericMotionEvent

open override fun onGenericMotionEvent(event: MotionEvent): Boolean

Called when a motion event has occurred.

onLowMemory

open override fun onLowMemory()

Called to reduce memory use

onSizeChanged

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

Called when the size has changed.

onStart

open override fun onStart()

Called to resume rendering

onStop

open override fun onStop()

Called to stop rendering

onTouchEvent

open override fun onTouchEvent(event: MotionEvent): Boolean

Called when a touch event has occurred.

queueEvent

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.

removeWidget

open override fun removeWidget(widget: Widget): Boolean

Remove Widget from the map.

setMaximumFps

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.

snapshot

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.

surfaceChanged

fun surfaceChanged(width: Int, height: Int)

Called when the surface dimensions have changed.

surfaceCreated

fun surfaceCreated()

Called when the surface has been created.

surfaceDestroyed

fun surfaceDestroyed()

Called when the surface

Properties

surface

val surface: Surface