This event is emitted whenever the visible viewport changes its size due to the invocation of the `setSize` and `setBounds` methods or when the camera is modified by calling camera methods.

CameraChangedCallback

interface CameraChangedCallback

This event is emitted whenever the visible viewport changes its size due to the invocation of the `setSize` and `setBounds` methods or when the camera is modified by calling camera methods.

CameraOptions

class CameraOptions : Serializable

Various options for describing the viewpoint of a camera.

CameraState

class CameraState : Serializable

Describes the viewpoint of a camera.

CanonicalTileID

class CanonicalTileID : Serializable

Represents a tile coordinate.

ClickInteraction

@MapboxExperimental

class ClickInteraction<T : BaseInteractiveFeature<*, *>> : MapInteraction

Defines the click interaction.

ConstrainMode

enum ConstrainMode

Describes whether to constrain the map in both axes or only vertically e.g.

ContextMode

enum ContextMode

Describes the map context mode.

CoordinateBounds

open class CoordinateBounds : Serializable

A rectangular area as measured on a two-dimensional map projection.

CoordinateBoundsZoom

class CoordinateBoundsZoom : Serializable

A coordinate bounds and zoom.

CoordinateInfo

class CoordinateInfo : Serializable

Represents the coordinate information returned by the `coordinateInfoForPixel` or `coordinatesInfoForPixels` methods.

CumulativeRenderingStatistics

class CumulativeRenderingStatistics : Serializable

CustomGeometrySourceOptions

class CustomGeometrySourceOptions : Serializable

Options for custom geometry source.

CustomLayerHost

interface CustomLayerHost

Interface for hosting a custom map style layer.

CustomLayerRenderConfiguration

class CustomLayerRenderConfiguration : Serializable

Note!

CustomLayerRenderParameters

class CustomLayerRenderParameters : Serializable

Parameters that define the current camera position for a `CustomLayerHost::render()` function.

CustomRasterSourceClient

open class CustomRasterSourceClient

CustomRasterSourceOptions

class CustomRasterSourceOptions : Serializable

Options for custom raster source.

CustomRasterSourceTileData

class CustomRasterSourceTileData : Serializable

Data for a specific CustomRasterSource tile.

CustomRasterSourceTileRenderer

interface CustomRasterSourceTileRenderer

Interface for the direct rendering into the custom raster tiles.

CustomRasterSourceTileStatus

enum CustomRasterSourceTileStatus

CustomRasterSource tile status.

CustomRasterSourceTileStatusChangedCallback

interface CustomRasterSourceTileStatusChangedCallback

Callback for changing a CustomRasterSource tile status.

DragInteraction

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

class DragInteraction<T : BaseInteractiveFeature<*, *>> : MapInteraction

For internal usage.

DurationStatistics

class DurationStatistics : Serializable

EdgeInsets

class EdgeInsets : Serializable

The distance on each side between rectangles, when one is contained into other.

ElevationData

interface ElevationData

Interface that provides access to elevation data.

EventTimeInterval

open class EventTimeInterval : Serializable

The time interval of an event.

FeatureExtensionValue

class FeatureExtensionValue : Serializable

A value or a collection of a feature extension.

FeaturesetQueryTarget

class FeaturesetQueryTarget : Serializable

Defines the parameters for querying features from a Featureset with an optional filter and id.

FeatureStateOperationCallback

interface FeatureStateOperationCallback

Callback to get operation status on the feature states asynchronously.

FreeCameraOptions

class FreeCameraOptions

Various options for accessing physical properties of the underlying camera entity.

GenericEvent

class GenericEvent : Serializable

The generic event type.

GenericEventCallback

interface GenericEventCallback

Generic event for experimental events.

GeoJSONSourceData

open class GeoJSONSourceData

GlyphsRasterizationMode

enum GlyphsRasterizationMode

Describes glyphs rasterization modes.

GlyphsRasterizationOptions

class GlyphsRasterizationOptions : Serializable

Describes the glyphs rasterization option values.

GroupPerformanceStatistics

class GroupPerformanceStatistics : Serializable

Image

class Image : Serializable

Image type.

ImageContent

class ImageContent : Serializable

Describes the image content, e.g.

ImageHolder

class ImageHolder : Parcelable

Class to hold image data either as drawable id or as the Bitmap.

ImageStretches

class ImageStretches : Serializable

Describes the image stretch areas.

ImportPosition

class ImportPosition : Serializable

Specifies position of an import that is added via addStyleImport method.

InteractionContext

open class InteractionContext : Serializable

A context of interaction containing the geographical and screen coordinate info.

LayerPosition

class LayerPosition : Serializable

Specifies position of a layer that is added via addStyleLayer method.

LongClickInteraction

@MapboxExperimental

class LongClickInteraction<T : BaseInteractiveFeature<*, *>> : MapInteraction

Defines the long click interaction.

MapboxAnnotationException

class MapboxAnnotationException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging annotation plugin related RuntimeException did occur.

MapboxCameraAnimationException

class MapboxCameraAnimationException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging camera animation plugin related RuntimeException did occur.

MapboxConcurrentGeometryModificationException

class MapboxConcurrentGeometryModificationException(exceptionText: String, sourceId: String) : ConcurrentModificationException

Mapbox exception thrown when any collection used to build GeoJson data is mutated.

MapboxConfigurationException

class MapboxConfigurationException : RuntimeException

A MapboxConfigurationException is thrown by MapboxMap when the SDK hasn't been properly initialised.

MapboxDelicateApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class MapboxDelicateApi

Marks declarations that are delicate — they have limited use-case and shall be used with care in general code. Any use of a delicate declaration has to be carefully reviewed to make sure it is properly used. Carefully read documentation of any declaration marked as MapboxDelicateApi.

MapboxExperimental

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class MapboxExperimental

Annotation class to mark API as experimental.

MapboxLifecycleObserver

interface MapboxLifecycleObserver

MapboxLifecycleObserver interface defines the lifecycle events that needed by MapView.

MapboxLocationComponentException

class MapboxLocationComponentException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging location component plugin related RuntimeException did occur.

MapboxMap

class MapboxMap : MapboxStyleManager, MapTransformDelegate, MapProjectionDelegate, MapFeatureQueryDelegate, MapListenerDelegate, MapPluginExtensionsDelegate, MapCameraManagerDelegate, MapInteractionDelegate

The general class to interact with in the Mapbox Maps SDK for Android. It exposes the entry point for all methods related to the Map object. You cannot instantiate MapboxMap object directly, rather, you must obtain one from the getMapboxMap() method MapView that you have added to your application.

MapboxMapException

class MapboxMapException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging map related RuntimeException did occur.

MapboxMapRecorder

@MapboxExperimental

class MapboxMapRecorder

MapboxMapRecorder provides functions to record and replay API calls of a MapboxMap instance. These recordings can be used to debug issues which require multiple steps to reproduce. Additionally, playbacks can be used for performance testing custom scenarios.

MapboxMapsOptions

object MapboxMapsOptions

Manages configuration options that are used by the Maps API objects, such as maps data directory and base URL.

MapboxStyleException

class MapboxStyleException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging style extension related RuntimeException did occur.

MapboxStyleManager

open class MapboxStyleManager @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor(val styleManager: StyleManager, val pixelRatio: Float, val mapLoadingErrorDelegate: MapLoadingErrorDelegate)

Wrapper class for StyleManager allowing to expose style related methods for MapboxMap.

MapboxTracing

object MapboxTracing

Allows to control several levels of tracing that could be useful to understand the performance of Mapbox Maps. For more details about Android tracing refer to relevant section of DEVELOPING.md file.

MapboxViewAnnotationException

class MapboxViewAnnotationException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging view annotation related RuntimeException did occur.

MapCenterAltitudeMode

enum MapCenterAltitudeMode

Defines how the map center point should react to terrain elevation changes.

MapConstants

class MapConstants

Collection of useful constants.

MapControllable

interface MapControllable : MapboxLifecycleObserver

MapControllable interface is the gateway for public API to talk to the internal map controller.

MapDebugOptions

enum MapDebugOptions

Options for enabling debugging features in a map.

MapIdle

class MapIdle : Serializable

The `map` has entered the idle state.

MapIdleCallback

interface MapIdleCallback

The `map` has entered the idle state.

MapInitOptions

data class MapInitOptions @JvmOverloads constructor(val context: Context, var mapOptions: MapOptions = getDefaultMapOptions(context), var plugins: List<Plugin> = defaultPluginList, var cameraOptions: CameraOptions? = null, var textureView: Boolean = false, val styleUri: String? = Style.STANDARD, var attrs: AttributeSet? = null, var antialiasingSampleCount: Int = DEFAULT_ANTIALIASING_SAMPLE_COUNT, var mapName: String = "")

Defines configuration MapInitOptions for a MapboxMap. These options can be used when adding a map to your application programmatically (as opposed to via XML). If you are using a MapFragment, you can pass these options in using the static factory method newInstance(MapboxMapOptions). If you are using a MapView, you can pass these options in using the constructor MapView(Context, MapboxMapOptions). If you add a map using XML, then you can apply these options using custom XML tags.

MapInteraction

@MapboxExperimental

abstract class MapInteraction

Base class for interactions.

MapLoaded

class MapLoaded : Serializable

The style has been fully loaded, and the `map` has rendered all visible tiles.

MapLoadedCallback

interface MapLoadedCallback

The style has been fully loaded, and the `map` has rendered all visible tiles.

MapLoadingError

class MapLoadingError : Serializable

Describes an error that has occurred while loading the `map`.

MapLoadingErrorCallback

interface MapLoadingErrorCallback

Describes an error that has occurred while loading the `map`.

MapLoadingErrorDelegate

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

fun interface MapLoadingErrorDelegate

For internal usage.

MapLoadingErrorType

enum MapLoadingErrorType

The enumeration defines map loading errors.

MapOptions

class MapOptions : Serializable

Describes the map option values.

MapPlayerOptions

class MapPlayerOptions : Serializable

Options for playback.

MapRecorderOptions

class MapRecorderOptions : Serializable

Options for recording.

MapSnapshotOptions

class MapSnapshotOptions : Serializable

Set of options for taking map snapshot with `map snapshotter`.

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.

MapView

open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable

A MapView 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.

MercatorCoordinate

class MercatorCoordinate : Serializable

Describes a point on the map in Mercator projection.

NorthOrientation

enum NorthOrientation

Describes the map orientation.

OfflineDatabaseMergeCallback

interface ~~OfflineDatabaseMergeCallback~~

Callback invoked when a sideloaded database has been merged into the main offline database.

OfflineManager

class OfflineManager

An `offline manager` manages downloads and storage for style packages and also produces tileset descriptors for the `tile store`.

OfflineRegion

class ~~OfflineRegion~~

An offline region represents an identifiable geographic region with optional metadata.

OfflineRegionCallback

interface ~~OfflineRegionCallback~~

Callback invoked when fetching existing regions.

OfflineRegionCreateCallback

interface ~~OfflineRegionCreateCallback~~

Callback invoked when creating a new region.

OfflineRegionDownloadState

enum ~~OfflineRegionDownloadState~~

Describes the download state of a region.

OfflineRegionError

class ~~OfflineRegionError~~ : Serializable

Describes an offline request response error.

OfflineRegionErrorType

enum ~~OfflineRegionErrorType~~

Describes the reason for an offline request response error.

OfflineRegionGeometryDefinition

class ~~OfflineRegionGeometryDefinition~~ : Serializable

An offline region definition is a geographic region defined by a style URL, a geometry, zoom range, and device pixel ratio.

OfflineRegionManager

class ~~OfflineRegionManager~~

The `offline region manager` that manages offline packs.

OfflineRegionObserver

interface ~~OfflineRegionObserver~~

A region can have a single observer, which gets notified whenever a change to the region's status occurs.

OfflineRegionStatus

class ~~OfflineRegionStatus~~ : Serializable

A region's status includes its active/inactive state as well as counts of the number of resources that have completed downloading, their total size in bytes, and the total number of resources that are required.

OfflineRegionStatusCallback

interface ~~OfflineRegionStatusCallback~~

Callback invoked when get offline region status operation completes.

OfflineRegionTilePyramidDefinition

class ~~OfflineRegionTilePyramidDefinition~~ : Serializable

An offline region definition is a geographic region defined by a style URL, geographic bounding box, zoom range, and device pixel ratio.

PerformanceSamplerOptions

enum PerformanceSamplerOptions

Samplers which can be optionally enabled to collect performance statistics.

PerformanceStatistics

class PerformanceStatistics : Serializable

The performance statistics collected at the end of the sampling duration.

PerformanceStatisticsCallback

interface PerformanceStatisticsCallback

Use this callback to observe the collected statistics.

PerformanceStatisticsOptions

class PerformanceStatisticsOptions : Serializable

Options for the following statistics collection behaviors:

Specify the types of sampling: cumulative, per-frame, or both.
Define the minimum elapsed time for collecting performance samples.

PerFrameRenderingStatistics

class PerFrameRenderingStatistics : Serializable

ProjectedMeters

class ProjectedMeters : Serializable

ProjectedMeters is a coordinate in a specific [Spherical Mercator](http://docs.openlayers.org/library/spherical_mercator.html) projection.

Projection

class Projection

Collection of [Spherical Mercator](http://docs.openlayers.org/library/spherical_mercator.html) projection methods.

QueriedFeature

class QueriedFeature : Serializable

Represents queried feature that is returned through `QueriedRenderedFeature` or `QueriedSourceFeature`

QueriedRenderedFeature

class QueriedRenderedFeature : Serializable

Represents query result that is returned in QueryRenderedFeaturesCallback.

QueriedSourceFeature

class QueriedSourceFeature : Serializable

Represents query result that is returned in QuerySourceFeaturesCallback.

QueryFeatureExtensionCallback

interface QueryFeatureExtensionCallback

Callback to get query feature extension asynchronously.

QueryFeatureStateCallback

interface QueryFeatureStateCallback

Callback to get query features asynchronously.

QueryRenderedFeaturesCallback

interface QueryRenderedFeaturesCallback

Callback to get queried rendered features asynchronously.

QuerySourceFeaturesCallback

interface QuerySourceFeaturesCallback

Callback to get queried source features asynchronously.

RenderedQueryGeometry

open class RenderedQueryGeometry

Geometry for querying rendered features.

RenderedQueryOptions

class RenderedQueryOptions : Serializable

Options for querying rendered features.

RenderFrameFinished

class RenderFrameFinished : Serializable

The `map` finished rendering a frame.

RenderFrameFinishedCallback

interface RenderFrameFinishedCallback

The `map` finished rendering a frame.

RenderFrameStarted

class RenderFrameStarted : Serializable

The `map` started rendering a frame.

RenderFrameStartedCallback

interface RenderFrameStartedCallback

The `map` started rendering a frame.

RenderModeType

enum RenderModeType

The enumeration defines the rendering mode for the rendered frame.

RequestDataSourceType

enum RequestDataSourceType

The enumeration defines the type of data source.

RequestErrorType

enum RequestErrorType

The enumeration defines the error type that may occur during a resource request.

RequestInfo

class RequestInfo : Serializable

The structure defines the information about the resource request.

RequestLoadingMethodType

enum RequestLoadingMethodType

The enumeration defines the method used to make a resource request.

RequestPriorityType

enum RequestPriorityType

The enumeration defines the priority of a resource request.

RequestResourceType

enum RequestResourceType

The enumeration defines the type of resource requested by the `map`.

ResourceRequest

class ResourceRequest : Serializable

The `ResourceRequest` event allows the application to observe resource requests made by a `map` or `map snapshotter` object.

ResourceRequestCallback

interface ResourceRequestCallback

The `ResourceRequest` event allows the application to observe resourcerequests made by a `map` or `map snapshotter` object.

ResourceRequestError

class ResourceRequestError : Serializable

The structure defines the information about errors that may occur during a resource request.

ResponseInfo

class ResponseInfo : Serializable

The structure defines the information about the response for the resource request.

ResponseSourceType

enum ResponseSourceType

The enumeration defines the source type that provides the requested resource.

ScreenBox

class ScreenBox : Serializable

Describes the coordinate box on the screen, measured in `platform pixels` from top to bottom and from left to right.

ScreenCoordinate

class ScreenCoordinate : Serializable

Describes the coordinate on the screen, measured from top to bottom and from left to right.

Size

class Size : Serializable

Size type.

SnapshotOverlay

abstract class SnapshotOverlay

An instance of overlay allowing to draw custom content directly over the snapshot image on the Canvas.

SnapshotOverlayCallback

fun interface SnapshotOverlayCallback

A block which can be used to obtain a SnapshotOverlay to draw custom content directly over the snapshot image.

SnapshotOverlayOptions

data class SnapshotOverlayOptions @JvmOverloads constructor(val showLogo: Boolean = true, val showAttributes: Boolean = true)

Data class to config the overlays on the snapshotter

SnapshotResultCallback

fun interface SnapshotResultCallback

Callback invoked when obtaining the map snapshot.

SnapshotStyleListener

interface SnapshotStyleListener

Interface for getting all style related events for snapshotter.

Snapshotter

open class Snapshotter

Snapshotter is high-level component responsible for taking map snapshot with given MapSnapshotOptions. The Snapshotter is valid until destroy is called.

SnapshotterDestroyedException

class SnapshotterDestroyedException : IllegalStateException

Runtime exception thrown when the Snapshotter has already been destroyed.

SourceAdded

class SourceAdded : Serializable

The source has been added with `addStyleSource` method.

SourceAddedCallback

interface SourceAddedCallback

The source has been added with `addStyleSource` method.

SourceDataLoaded

class SourceDataLoaded : Serializable

The `SourceDataLoaded` event is emitted when source data is loaded.

SourceDataLoadedCallback

interface SourceDataLoadedCallback

The `SourceDataLoaded` event is emitted when source data is loaded.

SourceDataLoadedType

enum SourceDataLoadedType

The enumeration defines the type of loaded source data.

SourceQueryOptions

class SourceQueryOptions : Serializable

Options for querying source features.

SourceRemoved

class SourceRemoved : Serializable

The source has been removed with `removeStyleSource` method.

SourceRemovedCallback

interface SourceRemovedCallback

The source has been removed with `removeStyleSource` method.

Style

class Style : MapboxStyleManager

The general class to interact with Styles in the Modular Mapbox Maps SDK for Android. It exposes the entry point for all methods related to the Style. You cannot instantiate Style object directly, rather, you must obtain one from the getStyle(onStyleLoaded) method on MapboxMap.

StyleDataLoaded

class StyleDataLoaded : Serializable

The style data has been loaded.

StyleDataLoadedCallback

interface StyleDataLoadedCallback

The style data has been loaded.

StyleDataLoadedType

enum StyleDataLoadedType

The enumeration defines the type of loaded style data.

StyleImageMissing

class StyleImageMissing : Serializable

A style needs an image that is missing from the sprite sheet.

StyleImageMissingCallback

interface StyleImageMissingCallback

A style needs an image that is missing from the sprite sheet.

StyleImageRemoveUnused

class StyleImageRemoveUnused : Serializable

An image requested by the `map` through the `StyleImageMissing` event is no longer needed and can be removed using the `removeStyleImage` method.

StyleImageRemoveUnusedCallback

interface StyleImageRemoveUnusedCallback

An image requested by the `map` through the `StyleImageMissing` event is no longer needed and can be removed using the `removeStyleImage` method.

StyleLoaded

class StyleLoaded : Serializable

The requested style has been fully loaded, including specified sprite, and sources' metadata.

StyleLoadedCallback

interface StyleLoadedCallback

The requested style has been fully loaded, including specified sprite, and sources' metadata.

StyleObjectInfo

class StyleObjectInfo : Serializable

The information about style object (source or layer or light).

StylePack

class StylePack : Serializable

The `style pack` represents a stored style package.

StylePackCallback

interface StylePackCallback

Callback invoked when returning a style package.

StylePackError

open class StylePackError : Serializable

Describes a style package load request error.

StylePackErrorType

enum StylePackErrorType

Describes the reason for a style package download request failure.

StylePackLoadOptions

class StylePackLoadOptions : Serializable

Describes the style package load option values.

StylePackLoadProgress

class StylePackLoadProgress : Serializable

A `style pack load` progress includes information about the number of resources that have completed downloading and the total number of resources that are required.

StylePackLoadProgressCallback

interface StylePackLoadProgressCallback

Callback Invoked to report the progess of the style package loading operation.

StylePackMetadataCallback

interface StylePackMetadataCallback

Callback invoked to return a style package's associated metadata

StylePacksCallback

interface StylePacksCallback

Callback invoked when returning existing style packages.

StylePropertyValue

class StylePropertyValue : Serializable

Holds a style property value with meta data.