Mapbox Maps Android/com.mapbox.maps.plugin

Package com.mapbox.maps.plugin

Types

ConstrainMode

The map constrain mode. This can be used to limit the map to wrap around the globe horizontally. By default, it is set to HeightOnly.

enum ConstrainMode : Enum<ConstrainMode>

ContextBinder

Interface to bind a View and underlying context

fun fun interface ContextBinder

ContextMode

The map context mode. This can be used to optimizations if we know that the drawing context is not shared with other code.

enum ContextMode : Enum<ContextMode>

GlyphRasterizationMode

Describes glyphs rasterization modes.

enum GlyphRasterizationMode : Enum<GlyphRasterizationMode>

InvalidPluginConfigurationException

Exception thrown when a plugin configuration is invalid.

class InvalidPluginConfigurationException(exceptionMessage: String) : Exception

InvalidViewPluginHostException

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

class InvalidViewPluginHostException(message: String) : Exception

LifecyclePlugin

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

interface LifecyclePlugin

LocationPuck

Sealed class representing a location-puck.

sealed class LocationPuck

LocationPuck2D

Definition of a location_puck_2_d.

data class LocationPuck2D(topImage: Drawable?, bearingImage: Drawable?, shadowImage: Drawable?, scaleExpression: String?) : LocationPuck

LocationPuck3D

Definition of a location_puck_3_d.

data class LocationPuck3D(modelUri: String, position: List<Float>, modelOpacity: Float, modelScale: List<Float>, modelScaleExpression: String?, modelRotation: List<Float>) : LocationPuck

MapCameraPlugin

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

fun fun interface MapCameraPlugin : MapPlugin

MapMode

The map rendering mode. By default, it is set to Continuous so the map will render as data arrives from the network and react immediately to state changes.

enum MapMode : Enum<MapMode>

MapPlugin

Parent definition of all Map plugins.

interface MapPlugin

MapSizePlugin

Plugin interface invoked when the size of map changes.

interface MapSizePlugin

MapStyleObserverPlugin

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

interface MapStyleObserverPlugin

Orientation

The orientation of the Map. By default, it is set to upwards.

enum Orientation : Enum<Orientation>

Position

Defines where the scale bar is positioned on the map

enum Position : Enum<Position>

Surface

The view type used to render.

enum Surface : Enum<Surface>

ViewPlugin

Defines interface of a ViewPlugin.

fun fun interface ViewPlugin : MapPlugin

ViewportMode

The viewport mode. This can be used to flip the vertical orientation of the map as some devices may use inverted orientation.

enum ViewportMode : Enum<ViewportMode>

Functions

equalsWithDelta

Extension function to compare two double with delta.

fun Double.equalsWithDelta(other: Double, delta: Double): Boolean

roughlyEquals

Extension function to compare two double with default delta of 1E-5.

fun Double.roughlyEquals(other: Double): Boolean

toJson

Extension function to compare two double with default delta of 1E-5.

fun Value.toJson(): String

Properties

PLUGIN_ANNOTATION_CLASS_NAME

Class name for annotation plugin.

const val PLUGIN_ANNOTATION_CLASS_NAME: String

PLUGIN_ATTRIBUTION_CLASS_NAME

Class name for map attribution plugin.

const val PLUGIN_ATTRIBUTION_CLASS_NAME: String

PLUGIN_CAMERA_ANIMATIONS_CLASS_NAME

Class name for camera animations plugin.

const val PLUGIN_CAMERA_ANIMATIONS_CLASS_NAME: String

PLUGIN_COMPASS_CLASS_NAME

Class name for compass plugin.

const val PLUGIN_COMPASS_CLASS_NAME: String

PLUGIN_GESTURE_CLASS_NAME

Class name for gestures plugin.

const val PLUGIN_GESTURE_CLASS_NAME: String

PLUGIN_LOCATION_CLASS_NAME

Class name for location plugin.

const val PLUGIN_LOCATION_CLASS_NAME: String

PLUGIN_LOCATION_COMPONENT_CLASS_NAME

Class name for location component plugin.

const val PLUGIN_LOCATION_COMPONENT_CLASS_NAME: String

PLUGIN_LOGO_CLASS_NAME

Class name for logo plugin.

const val PLUGIN_LOGO_CLASS_NAME: String

PLUGIN_MAPOVERLAY_CLASS_NAME

Class name for map overlay plugin.

const val PLUGIN_MAPOVERLAY_CLASS_NAME: String

PLUGIN_SCALE_BAR_CLASS_NAME

Class name for scale bar plugin.

const val PLUGIN_SCALE_BAR_CLASS_NAME: String