Package com.mapbox.maps

Types

AsyncOperationResultCallback

androidJvm

interface AsyncOperationResultCallback

Callback invoked once an asynchronous operation completes.

AsyncOperationResultCallbackNative

androidJvm

class AsyncOperationResultCallbackNative : AsyncOperationResultCallback

Callback invoked once an asynchronous operation completes.

CameraBounds

androidJvm

class CameraBounds : Serializable

Holds information about `camera bounds`.

CameraBoundsOptions

androidJvm

open class CameraBoundsOptions : Serializable

Holds options to be used for setting `camera bounds`.

CameraManager

androidJvm

open class CameraManager : StyleManager, CameraManagerInterface

Interface for managing camera.

CameraManagerInterface

androidJvm

interface CameraManagerInterface : StyleManagerInterface

Interface for managing camera.

CameraOptions

androidJvm

class CameraOptions : Serializable

Various options for describing the viewpoint of a camera.

CameraState

androidJvm

class CameraState : Serializable

Describes the viewpoint of a camera.

CancelTileFunctionCallback

androidJvm

interface CancelTileFunctionCallback

Callback to cancel a tile.

CancelTileFunctionCallbackNative

androidJvm

class CancelTileFunctionCallbackNative : CancelTileFunctionCallback

Callback to cancel a tile.

CanonicalTileID

androidJvm

class CanonicalTileID : Serializable

Represents a tile coordinate.

ConstrainMode

androidJvm

enum ConstrainMode

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

ContextMode

androidJvm

enum ContextMode

Describes the map context mode.

CoordinateBounds

androidJvm

open class CoordinateBounds : Serializable

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

CoordinateBoundsZoom

androidJvm

class CoordinateBoundsZoom : Serializable

A coordinate bounds and zoom.

CustomGeometrySourceOptions

androidJvm

class CustomGeometrySourceOptions : Serializable

Options for custom geometry source.

CustomLayerHost

androidJvm

interface CustomLayerHost

Interface for hosting a custom map style layer.

CustomLayerHostNative

androidJvm

class CustomLayerHostNative : CustomLayerHost

Interface for hosting a custom map style layer.

CustomLayerRenderParameters

androidJvm

class CustomLayerRenderParameters : Serializable

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

EdgeInsets

androidJvm

class EdgeInsets : Serializable

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

ElevationData

androidJvm

interface ElevationData

Interface that provides access to elevation data.

ElevationDataNative

androidJvm

class ElevationDataNative : ElevationData

Interface that provides access to elevation data.

Event

androidJvm

class Event : Serializable

Generic Event type used to notify an `observer`.

FeatureExtensionValue

androidJvm

class FeatureExtensionValue : Serializable

A value or a collection of a feature extension.

FetchTileFunctionCallback

androidJvm

interface FetchTileFunctionCallback

Callback to create data for tile.

FetchTileFunctionCallbackNative

androidJvm

class FetchTileFunctionCallbackNative : FetchTileFunctionCallback

Callback to create data for tile.

FreeCameraOptions

androidJvm

class FreeCameraOptions

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

GlyphsRasterizationMode

androidJvm

enum GlyphsRasterizationMode

Describes glyphs rasterization modes.

GlyphsRasterizationOptions

androidJvm

class GlyphsRasterizationOptions : Serializable

Describes the glyphs rasterization option values.

Image

androidJvm

class Image : Serializable

Image type.

ImageContent

androidJvm

class ImageContent : Serializable

Describes the image content, e.g.

ImageStretches

androidJvm

class ImageStretches : Serializable

Describes the image stretch areas.

LayerPosition

androidJvm

class LayerPosition : Serializable

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

Map

androidJvm

class Map : CameraManager, MapInterface

Map class provides map rendering functionality.

MapboxAnnotationException

androidJvm

class MapboxAnnotationException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging annotation plugin related RuntimeException did occur.

MapboxCameraAnimationException

androidJvm

class MapboxCameraAnimationException(exceptionText: String?) : RuntimeException

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

MapboxConfigurationException

androidJvm

class MapboxConfigurationException : RuntimeException

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

MapboxExperimental

androidJvm

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

annotation class MapboxExperimental

Annotation class to mark API as experimental.

MapboxLifecycleObserver

androidJvm

interface MapboxLifecycleObserver

MapboxLifecycleObserver interface defines the lifecycle events that needed by MapView.

MapboxLocationComponentException

androidJvm

class MapboxLocationComponentException(exceptionText: String?) : RuntimeException

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

MapboxMap

androidJvm

class MapboxMap : MapTransformDelegate, MapProjectionDelegate, MapFeatureQueryDelegate, ObservableInterface, MapListenerDelegate, MapPluginExtensionsDelegate, MapCameraManagerDelegate, MapStyleStateDelegate

The general class to interact with in the Mapbox Maps SDK for Android.

MapboxMapException

androidJvm

class MapboxMapException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging map related RuntimeException did occur.

MapboxStyleException

androidJvm

class MapboxStyleException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging style extension related RuntimeException did occur.

MapboxViewAnnotationException

androidJvm

class MapboxViewAnnotationException(exceptionText: String?) : RuntimeException

Mapbox exception class flagging view annotation related RuntimeException did occur.

MapClient

androidJvm

interface MapClient

MapClientNative

androidJvm

class MapClientNative : MapClient

MapConstants

androidJvm

class MapConstants

Collection of useful constants.

MapControllable

androidJvm

interface MapControllable : MapboxLifecycleObserver

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

MapDebugOptions

androidJvm

enum MapDebugOptions

Options for enabling debugging features in a map.

MapEvents

androidJvm

class MapEvents

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

MapInitOptions

androidJvm

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.

MapInterface

androidJvm

interface MapInterface : CameraManagerInterface

Map class provides map rendering functionality.

MapMemoryBudget

androidJvm

open class MapMemoryBudget

MapMemoryBudgetInMegabytes

androidJvm

open class MapMemoryBudgetInMegabytes : Serializable

Map memory budget in megabytes.

MapMemoryBudgetInTiles

androidJvm

open class MapMemoryBudgetInTiles : Serializable

Map memory budget in tiles.

MapOptions

androidJvm

class MapOptions : Serializable

Describes the map option values.

MapSnapshot

androidJvm

class MapSnapshot : MapSnapshotInterface

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

MapSnapshotInterface

androidJvm

interface MapSnapshotInterface

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

MapSnapshotOptions

androidJvm

class MapSnapshotOptions : Serializable

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

MapSnapshotter

androidJvm

class MapSnapshotter : CameraManager, MapSnapshotterInterface

MapSnapshotter exposes functionality to capture static map images.

MapSnapshotterInterface

androidJvm

interface MapSnapshotterInterface : CameraManagerInterface

MapSnapshotter exposes functionality to capture static map images.

MapSurface

androidJvm

class MapSurface @JvmOverloads() constructor(context: Context, surface: Surface, mapInitOptions: MapInitOptions) : MapPluginProviderDelegate, MapControllable

A MapSurface provides an embeddable map interface.

MapView

androidJvm

open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable

A MapView provides an embeddable map interface.

MercatorCoordinate

androidJvm

class MercatorCoordinate : Serializable

Describes a point on the map in Mercator projection.

NorthOrientation

androidJvm

enum NorthOrientation

Describes the map orientation.

Observable

androidJvm

open class Observable : ObservableInterface

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

ObservableInterface

androidJvm

interface ObservableInterface

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

Observer

androidJvm

interface Observer

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

ObserverNative

androidJvm

class ObserverNative : Observer

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

OfflineDatabaseMergeCallback

androidJvm

@Deprecated()

interface OfflineDatabaseMergeCallback

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

OfflineDatabaseMergeCallbackNative

androidJvm

@Deprecated()

class OfflineDatabaseMergeCallbackNative : OfflineDatabaseMergeCallback

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

OfflineManager

androidJvm

class OfflineManager : OfflineManagerInterface

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

OfflineManagerInterface

androidJvm

interface OfflineManagerInterface

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

OfflineRegion

androidJvm

@Deprecated()

class OfflineRegion : OfflineRegionInterface

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

OfflineRegionCallback

androidJvm

@Deprecated()

interface OfflineRegionCallback

Callback invoked when fetching existing regions.

OfflineRegionCallbackNative

androidJvm

@Deprecated()

class OfflineRegionCallbackNative : OfflineRegionCallback

Callback invoked when fetching existing regions.

OfflineRegionCreateCallback

androidJvm

@Deprecated()

interface OfflineRegionCreateCallback

Callback invoked when creating a new region.

OfflineRegionCreateCallbackNative

androidJvm

@Deprecated()

class OfflineRegionCreateCallbackNative : OfflineRegionCreateCallback

Callback invoked when creating a new region.

OfflineRegionDownloadState

androidJvm

@Deprecated()

enum OfflineRegionDownloadState

Describes the download state of a region.

OfflineRegionGeometryDefinition

androidJvm

@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

androidJvm

@Deprecated()

interface OfflineRegionInterface

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

OfflineRegionManager

androidJvm

@Deprecated()

class OfflineRegionManager : OfflineRegionManagerInterface

The `offline region manager` that manages offline packs.

OfflineRegionManagerInterface

androidJvm

@Deprecated()

interface OfflineRegionManagerInterface

The `offline region manager` that manages offline packs.

OfflineRegionObserver

androidJvm

@Deprecated()

interface OfflineRegionObserver

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

OfflineRegionObserverNative

androidJvm

@Deprecated()

class OfflineRegionObserverNative : OfflineRegionObserver

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

OfflineRegionStatus

androidJvm

@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

androidJvm

@Deprecated()

interface OfflineRegionStatusCallback

Callback invoked when get offline region status operation completes.

OfflineRegionStatusCallbackNative

androidJvm

@Deprecated()

class OfflineRegionStatusCallbackNative : OfflineRegionStatusCallback

Callback invoked when get offline region status operation completes.

OfflineRegionTilePyramidDefinition

androidJvm

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

ProjectedMeters

androidJvm

class ProjectedMeters : Serializable

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

Projection

androidJvm

class Projection

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

QueriedFeature

androidJvm

class QueriedFeature : Serializable

Represents query result that is returned in QueryFeaturesCallback.

QueryFeatureExtensionCallback

androidJvm

interface QueryFeatureExtensionCallback

Callback to get query feature extension asynchronously.

QueryFeatureExtensionCallbackNative

androidJvm

class QueryFeatureExtensionCallbackNative : QueryFeatureExtensionCallback

Callback to get query feature extension asynchronously.

QueryFeaturesCallback

androidJvm

interface QueryFeaturesCallback

Callback to get query features asynchronously.

QueryFeaturesCallbackNative

androidJvm

class QueryFeaturesCallbackNative : QueryFeaturesCallback

Callback to get query features asynchronously.

QueryFeatureStateCallback

androidJvm

interface QueryFeatureStateCallback

Callback to get query features asynchronously.

QueryFeatureStateCallbackNative

androidJvm

class QueryFeatureStateCallbackNative : QueryFeatureStateCallback

Callback to get query features asynchronously.

RenderCacheOptions

androidJvm

class RenderCacheOptions : Serializable

Parameters that defines behavior of the render cache.

RenderedQueryGeometry

androidJvm

open class RenderedQueryGeometry

Geometry for querying rendered features.

RenderedQueryOptions

androidJvm

class RenderedQueryOptions : Serializable

Options for querying rendered features.

ResourceOptions

androidJvm

class ResourceOptions : Serializable

Options to configure a resource

ResourceOptionsManager

androidJvm

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

androidJvm

@Deprecated()

class ResponseError : Serializable

Describes an offline request response error.

ResponseErrorReason

androidJvm

@Deprecated()

enum ResponseErrorReason

Describes the reason for an offline request response error.

ScreenBox

androidJvm

class ScreenBox : Serializable

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

ScreenCoordinate

androidJvm

class ScreenCoordinate : Serializable

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

Settings

androidJvm

@Deprecated()

class Settings

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

Size

androidJvm

class Size : Serializable

Size type.

SnapshotCompleteCallback

androidJvm

interface SnapshotCompleteCallback

Callback invoked once a snapshot operation completes.

SnapshotCompleteCallbackNative

androidJvm

class SnapshotCompleteCallbackNative : SnapshotCompleteCallback

Callback invoked once a snapshot operation completes.

SnapshotCreatedListener

androidJvm

fun fun interface SnapshotCreatedListener

Interface for getting snapshot when it's finished.

SnapshotOverlayOptions

androidJvm

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

Data class to config the overlays on the snapshotter

SnapshotStyleListener

androidJvm

interface SnapshotStyleListener

Interface for getting all style related events for snapshotter.

Snapshotter

androidJvm

open class Snapshotter

Snapshotter is high-level component responsible for taking map snapshot with given MapSnapshotOptions.

SourceQueryOptions

androidJvm

class SourceQueryOptions : Serializable

Options for querying source features.

Style

androidJvm

class Style : StyleInterface

The general class to interact with Styles in the Modular Mapbox Maps SDK for Android.

StyleManager

androidJvm

open class StyleManager : Observable, StyleManagerInterface

Interface for managing style of the `map`.

StyleManagerInterface

androidJvm

interface StyleManagerInterface : ObservableInterface

Interface for managing style of the `map`.

StyleObjectInfo

androidJvm

class StyleObjectInfo : Serializable

The information about style object (source or layer).

StylePack

androidJvm

class StylePack : Serializable

The `style pack` represents a stored style package.

StylePackCallback

androidJvm

interface StylePackCallback

Callback invoked when returning a style package.

StylePackCallbackNative

androidJvm

class StylePackCallbackNative : StylePackCallback

Callback invoked when returning a style package.

StylePackError

androidJvm

open class StylePackError : Serializable

Describes a style package load request error.

StylePackErrorType

androidJvm

enum StylePackErrorType

Describes the reason for a style package download request failure.

StylePackLoadOptions

androidJvm

class StylePackLoadOptions : Serializable

Describes the style package load option values.

StylePackLoadProgress

androidJvm

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

androidJvm

interface StylePackLoadProgressCallback

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

StylePackLoadProgressCallbackNative

androidJvm

class StylePackLoadProgressCallbackNative : StylePackLoadProgressCallback

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

StylePackMetadataCallback

androidJvm

interface StylePackMetadataCallback

Callback invoked to return a style package's associated metadata