Package-level declarations
Types
Defines the click interaction.
For internal usage.
Class to hold image data either as drawable id or as the Bitmap.
Defines the long click interaction.
Mapbox exception class flagging annotation plugin related RuntimeException did occur.
Mapbox exception class flagging camera animation plugin related RuntimeException did occur.
Mapbox exception thrown when any collection used to build GeoJson data is mutated.
A MapboxConfigurationException is thrown by MapboxMap when the SDK hasn't been properly initialised.
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.
Annotation class to mark API as experimental.
MapboxLifecycleObserver interface defines the lifecycle events that needed by MapView.
Mapbox exception class flagging location component plugin related RuntimeException did occur.
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.
Mapbox exception class flagging map related RuntimeException did occur.
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.
Manages configuration options that are used by the Maps API objects, such as maps data directory and base URL.
Mapbox exception class flagging style extension related RuntimeException did occur.
Wrapper class for StyleManager allowing to expose style related methods for MapboxMap.
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.
Mapbox exception class flagging view annotation related RuntimeException did occur.
MapControllable interface is the gateway for public API to talk to the internal map controller.
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.
For internal usage.
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.
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.
An instance of overlay allowing to draw custom content directly over the snapshot image on the Canvas.
A block which can be used to obtain a SnapshotOverlay to draw custom content directly over the snapshot image.
Data class to config the overlays on the snapshotter
Callback invoked when obtaining the map snapshot.
Interface for getting all style related events for snapshotter.
Snapshotter is high-level component responsible for taking map snapshot with given MapSnapshotOptions. The Snapshotter is valid until destroy is called.
Runtime exception thrown when the Snapshotter has already been destroyed.
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.
Functions
Get a default MapOptions.Builder with reasterization mode GlyphsRasterizationMode#ALL_GLYPHS_RASTERIZED_LOCALLY
Log Android debug entry in the following format: D/Mapbox: [SDK_IDENTIFIER]\ [tag]
Log Android error entry in the following format: E/Mapbox: [SDK_IDENTIFIER]\ [tag]
Log Android info entry in the following format: I/Mapbox: [SDK_IDENTIFIER]\ [tag]
Log Android warning entry in the following format: W/Mapbox: [SDK_IDENTIFIER]\ [tag]
DSL builder function to create MapPlayerOptions object.
DSL builder function to create MapRecorderOptions object.
Extension function to convert CameraState to CameraOptions.
Convert Bitmap to rendering engine Image instance.