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.

MapboxStyleException

class MapboxStyleException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging style extension related RuntimeException did occur.

MapboxViewAnnotationException

class MapboxViewAnnotationException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging view annotation related RuntimeException did occur.

MapClient

interface MapClient

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.

MapEvents

class MapEvents

List of supported event types by the `map` and `map snapshotter` objects, and event data format specification for each event.

MapInitOptions

data class MapInitOptions @JvmOverloads constructor(context: Context, resourceOptions: ResourceOptions, mapOptions: MapOptions, plugins: List<Plugin>, cameraOptions: CameraOptions?, textureView: Boolean, styleUri: String?, attrs: AttributeSet?, antialiasingSampleCount: Int)

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.

MapInterface

interface MapInterface : CameraManagerInterface

Map class provides map rendering functionality.

MapMemoryBudget

open class MapMemoryBudget

MapMemoryBudgetInMegabytes

open class MapMemoryBudgetInMegabytes : Serializable

Map memory budget in megabytes.

MapMemoryBudgetInTiles

open class MapMemoryBudgetInTiles : Serializable

Map memory budget in tiles.

MapOptions

class MapOptions : Serializable

Describes the map option values.

MapSnapshotInterface

interface MapSnapshotInterface

An image snapshot of a map rendered by `map snapshotter`.

MapSnapshotOptions

class MapSnapshotOptions : Serializable

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

MapSnapshotterInterface

interface MapSnapshotterInterface : CameraManagerInterface

MapSnapshotter exposes functionality to capture static map images.

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.

Observable

open class Observable : ObservableInterface

The `observable` interface provides basic Publish&Subscribe functionality.

ObservableInterface

interface ObservableInterface

The `observable` interface provides basic Publish&Subscribe functionality.

Observer

interface Observer

An `observer` interface used to subscribe for an `observable` events.

OfflineDatabaseMergeCallback

@Deprecated

~~interface~~ ~~OfflineDatabaseMergeCallback~~

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

OfflineManager

class OfflineManager : OfflineManagerInterface

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

OfflineManagerInterface

interface OfflineManagerInterface

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

OfflineRegion

@Deprecated

~~class~~ ~~OfflineRegion~~ : ~~OfflineRegionInterface~~

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

OfflineRegionCallback

@Deprecated

~~interface~~ ~~OfflineRegionCallback~~

Callback invoked when fetching existing regions.

OfflineRegionCreateCallback

@Deprecated

~~interface~~ ~~OfflineRegionCreateCallback~~

Callback invoked when creating a new region.

OfflineRegionDownloadState

@Deprecated

~~enum~~ ~~OfflineRegionDownloadState~~

Describes the download state of a region.

OfflineRegionGeometryDefinition

@Deprecated

~~class~~ ~~OfflineRegionGeometryDefinition~~ : ~~Serializable~~

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

OfflineRegionInterface

@Deprecated

~~interface~~ ~~OfflineRegionInterface~~

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

OfflineRegionManager

@Deprecated

~~class~~ ~~OfflineRegionManager~~ : ~~OfflineRegionManagerInterface~~

The `offline region manager` that manages offline packs.

OfflineRegionManagerInterface

@Deprecated

~~interface~~ ~~OfflineRegionManagerInterface~~

The `offline region manager` that manages offline packs.

OfflineRegionObserver

@Deprecated

~~interface~~ ~~OfflineRegionObserver~~

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

OfflineRegionStatus

@Deprecated

~~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

@Deprecated

~~interface~~ ~~OfflineRegionStatusCallback~~

Callback invoked when get offline region status operation completes.

OfflineRegionTilePyramidDefinition

@Deprecated

~~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.

PlaybackFinished

interface PlaybackFinished

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 query result that is returned in QueryFeaturesCallback.

QueryFeatureExtensionCallback

interface QueryFeatureExtensionCallback

Callback to get query feature extension asynchronously.

QueryFeaturesCallback

interface QueryFeaturesCallback

Callback to get query features asynchronously.

QueryFeatureStateCallback

interface QueryFeatureStateCallback

Callback to get query features asynchronously.

RenderCacheOptions

class RenderCacheOptions : Serializable

Parameters that defines behavior of the render cache.

RenderedQueryGeometry

open class RenderedQueryGeometry

Geometry for querying rendered features.

RenderedQueryOptions

class RenderedQueryOptions : Serializable

Options for querying rendered features.

ResourceOptions

class ResourceOptions : Serializable

Options to configure a resource

ResourceOptionsManager

data class ResourceOptionsManager(resourceOptions: ResourceOptions)

Convenience class that manages a global ResourceOptions It's possible to create ResourceOptionsManager instances as you need them, however it's convenient to use the default object (default).

ResponseError

@Deprecated

~~class~~ ~~ResponseError~~ : ~~Serializable~~

Describes an offline request response error.

ResponseErrorReason

@Deprecated

~~enum~~ ~~ResponseErrorReason~~

Describes the reason for an offline request response error.

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.

Settings

@Deprecated

~~class~~ ~~Settings~~

Settings class provides non-persistent, in-process key-value storage.

Size

class Size : Serializable

Size type.

SnapshotCompleteCallback

interface SnapshotCompleteCallback

Callback invoked once a snapshot operation completes.

SnapshotCreatedListener

fun interface SnapshotCreatedListener

Interface for getting snapshot when it's finished.

SnapshotOverlayOptions

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

Data class to config the overlays on the snapshotter

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.

SourceQueryOptions

class SourceQueryOptions : Serializable

Options for querying source features.

Style

class Style : StyleInterface

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.

StyleManager

open class StyleManager : Observable, StyleManagerInterface

Interface for managing style of the `map`.

StyleManagerInterface

interface StyleManagerInterface : ObservableInterface

Interface for managing style of the `map`.

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.