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

Package-level declarations

Types

Interface to bind a View and underlying context

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class DisabledPlugin(val message: String) : MapPlugin

A placeholder MapPlugin used to intentionally disable another plugin while keeping its id registered on the map. A host that replaces a plugin with its own implementation can register Plugin.Custom(id, DisabledPlugin(..)) in place of the real plugin.

DistanceUnits

class DistanceUnits(val value: String) : Parcelable

Supported distance unit types.

InvalidPluginConfigurationException

class InvalidPluginConfigurationException(exceptionMessage: String) : Exception

Exception thrown when a plugin configuration is invalid.

InvalidViewPluginHostException

class InvalidViewPluginHostException(message: String) : Exception

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

LifecyclePlugin

interface LifecyclePlugin

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

LocationPuck

sealed class LocationPuck : Parcelable

Sealed class representing a location-puck.

LocationPuck2D

data class LocationPuck2D @JvmOverloads constructor(var topImage: ImageHolder? = null, var bearingImage: ImageHolder? = null, var shadowImage: ImageHolder? = null, var scaleExpression: String? = null, var opacity: Float = 1.0f) : LocationPuck

Definition of a location_puck_2_d.

LocationPuck3D

data class LocationPuck3D @JvmOverloads constructor(var modelUri: String, var position: List<Float> = listOf(0f, 0f), var modelOpacity: Float = 1.0f, var modelScale: List<Float> = listOf(1f, 1f, 1f), var modelScaleExpression: String? = null, var modelTranslation: List<Float> = listOf(0f, 0f, 0f), var modelRotation: List<Float> = listOf(0f, 0f, 90f), var modelCastShadows: Boolean = true, var modelReceiveShadows: Boolean = true, var modelScaleMode: ModelScaleMode = ModelScaleMode.VIEWPORT, var modelEmissiveStrength: Float = 1.0f, var modelEmissiveStrengthExpression: String? = null, var modelOpacityExpression: String? = null, var modelRotationExpression: String? = null, var modelColor: Int = Color.parseColor("#ffffff"), var modelColorExpression: String? = null, var modelColorMixIntensity: Float = 0.0f, var modelColorMixIntensityExpression: String? = null, var materialOverrides: List<String> = emptyList(), var nodeOverrides: List<String> = emptyList(), var modelElevationReference: ModelElevationReference = ModelElevationReference.GROUND, var modelColorUseTheme: String = "default", var modelColorUseThemeExpression: String? = null) : LocationPuck

Definition of a location_puck_3_d.

MapCameraPlugin

fun interface MapCameraPlugin : MapPlugin

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

MapPlugin

interface MapPlugin

Parent definition of all Map plugins.

MapSizePlugin

interface MapSizePlugin

Plugin interface invoked when the size of map changes.

MapStyleObserverPlugin

interface MapStyleObserverPlugin

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

ModelElevationReference

@MapboxExperimental

enum ModelElevationReference : Enum<ModelElevationReference>

Selects the base of the model. Some modes might require precomputed elevation data in the tileset.

ModelScaleMode

@MapboxExperimental

enum ModelScaleMode : Enum<ModelScaleMode>

Defines scaling mode. Only applies to location-indicator type layers.

Plugin

sealed class Plugin

Class describing plugin instance.

PluginDisabledException

class PluginDisabledException(message: String) : RuntimeException

Exception thrown when accessing a plugin that the host intentionally disabled for the current map by registering a DisabledPlugin placeholder in its place.

PuckBearing

enum PuckBearing : Enum<PuckBearing>

The enum controls how the puck is oriented

ScrollMode

enum ScrollMode : Enum<ScrollMode>

Configures the directions in which the map is allowed to move during a scroll gesture.

ViewPlugin

fun interface ViewPlugin : MapPlugin

Defines interface of a ViewPlugin.