Package com.mapbox.maps.plugin

Types

ContextBinder
Link copied to clipboard

Interface to bind a View and underlying context

fun fun interface ContextBinder
InvalidPluginConfigurationException
Link copied to clipboard

Exception thrown when a plugin configuration is invalid.

class InvalidPluginConfigurationException(exceptionMessage: String) : Exception
InvalidViewPluginHostException
Link copied to clipboard

Exception thrown when a ViewPlugin is loaded in a context that doesn't have a view hierarchy associated.

class InvalidViewPluginHostException(message: String) : Exception
LifecyclePlugin
Link copied to clipboard

Interface for plugins interacting with the lifecycle of the hosting context.

interface LifecyclePlugin
LocationPuck
Link copied to clipboard

Sealed class representing a location-puck.

sealed class LocationPuck
LocationPuck2D
Link copied to clipboard

Definition of a location_puck_2_d.

data class LocationPuck2D(topImage: Drawable?, bearingImage: Drawable?, shadowImage: Drawable?, scaleExpression: String?) : LocationPuck
LocationPuck3D
Link copied to clipboard

Definition of a location_puck_3_d.

data class LocationPuck3D(modelUri: String, position: List<Float>, modelOpacity: Float, modelScale: List<Float>, modelScaleExpression: String?, modelTranslation: List<Float>, modelRotation: List<Float>) : LocationPuck
MapCameraPlugin
Link copied to clipboard

Definition for map camera plugins. The map will constantly push current camera position values.

fun fun interface MapCameraPlugin : MapPlugin
MapPlugin
Link copied to clipboard

Parent definition of all Map plugins.

interface MapPlugin
MapSizePlugin
Link copied to clipboard

Plugin interface invoked when the size of map changes.

interface MapSizePlugin
MapStyleObserverPlugin
Link copied to clipboard

Interface for plugins need to be aware of the style change event.

interface MapStyleObserverPlugin
PanScrollMode
Link copied to clipboard

Whether the user is restricted in which direction the map is scrolled.

enum PanScrollMode : Enum<PanScrollMode>
Plugin
Link copied to clipboard

Class describing plugin instance.

For Mapbox plugins it is enough to provide plugin id from this class without plugin instance. For user-defined plugins both unique id and plugin instance must be provided.

sealed class Plugin
ViewPlugin
Link copied to clipboard

Defines interface of a ViewPlugin.

fun fun interface ViewPlugin : MapPlugin