Package com.mapbox.maps

Types

AsyncOperationResultCallback
Link copied to clipboard

Callback invoked once an asynchronous operation completes.

interface AsyncOperationResultCallback
interface AsyncOperationResultCallback
interface AsyncOperationResultCallback
AsyncOperationResultCallbackNative
Link copied to clipboard

Callback invoked once an asynchronous operation completes.

CameraBounds
Link copied to clipboard

Holds information about `camera bounds`.

class CameraBounds : Serializable
class CameraBounds : Serializable
class CameraBounds : Serializable
CameraBoundsOptions
Link copied to clipboard

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

open class CameraBoundsOptions : Serializable
open class CameraBoundsOptions : Serializable
open class CameraBoundsOptions : Serializable
CameraManager
Link copied to clipboard

Interface for managing camera.

open class CameraManager : StyleManager, CameraManagerInterface
open class CameraManager : StyleManager, CameraManagerInterface
open class CameraManager : StyleManager, CameraManagerInterface
CameraManagerInterface
Link copied to clipboard

Interface for managing camera.

interface CameraManagerInterface : StyleManagerInterface
interface CameraManagerInterface : StyleManagerInterface
interface CameraManagerInterface : StyleManagerInterface
CameraOptions
Link copied to clipboard

Various options for describing the viewpoint of a camera. All fields are optional. Anchor and center points are mutually exclusive, with preference for the center point when both are set.

class CameraOptions : Serializable
class CameraOptions : Serializable
class CameraOptions : Serializable
CameraState
Link copied to clipboard

Describes the viewpoint of a camera.

class CameraState : Serializable
class CameraState : Serializable
class CameraState : Serializable
CancelTileFunctionCallback
Link copied to clipboard

Callback to cancel a tile.

interface CancelTileFunctionCallback
interface CancelTileFunctionCallback
interface CancelTileFunctionCallback
CancelTileFunctionCallbackNative
Link copied to clipboard

Callback to cancel a tile.

CanonicalTileID
Link copied to clipboard

Represents a tile coordinate.

class CanonicalTileID : Serializable
class CanonicalTileID : Serializable
class CanonicalTileID : Serializable
ConstrainMode
Link copied to clipboard

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

enum ConstrainMode
enum ConstrainMode
enum ConstrainMode
ContextMode
Link copied to clipboard

Describes the map context mode. We can make some optimizations if we know that the drawing context is not shared with other code.

enum ContextMode
enum ContextMode
enum ContextMode
CoordinateBounds
Link copied to clipboard

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

open class CoordinateBounds : Serializable
open class CoordinateBounds : Serializable
open class CoordinateBounds : Serializable
CoordinateBoundsZoom
Link copied to clipboard

A coordinate bounds and zoom.

class CoordinateBoundsZoom : Serializable
class CoordinateBoundsZoom : Serializable
class CoordinateBoundsZoom : Serializable
CustomGeometrySourceOptions
Link copied to clipboard

Options for custom geometry source.

class CustomGeometrySourceOptions : Serializable
class CustomGeometrySourceOptions : Serializable
class CustomGeometrySourceOptions : Serializable
CustomLayerHost
Link copied to clipboard

Interface for hosting a custom map style layer.

interface CustomLayerHost
interface CustomLayerHost
interface CustomLayerHost
CustomLayerHostNative
Link copied to clipboard

Interface for hosting a custom map style layer.

class CustomLayerHostNative : CustomLayerHost
class CustomLayerHostNative : CustomLayerHost
class CustomLayerHostNative : CustomLayerHost
CustomLayerRenderParameters
Link copied to clipboard

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

class CustomLayerRenderParameters : Serializable
class CustomLayerRenderParameters : Serializable
class CustomLayerRenderParameters : Serializable
EdgeInsets
Link copied to clipboard

The distance on each side between rectangles, when one is contained into other. All fields' values are in `platform pixel` units.

class EdgeInsets : Serializable
class EdgeInsets : Serializable
class EdgeInsets : Serializable
ElevationData
Link copied to clipboard

Interface that provides access to elevation data.

interface ElevationData
interface ElevationData
interface ElevationData
ElevationDataNative
Link copied to clipboard

Interface that provides access to elevation data.

class ElevationDataNative : ElevationData
class ElevationDataNative : ElevationData
class ElevationDataNative : ElevationData
Event
Link copied to clipboard

Generic Event type used to notify an `observer`.

class Event : Serializable
class Event : Serializable
class Event : Serializable
FeatureExtensionValue
Link copied to clipboard

A value or a collection of a feature extension.

class FeatureExtensionValue : Serializable
class FeatureExtensionValue : Serializable
class FeatureExtensionValue : Serializable
FetchTileFunctionCallback
Link copied to clipboard

Callback to create data for tile.

interface FetchTileFunctionCallback
interface FetchTileFunctionCallback
interface FetchTileFunctionCallback
FetchTileFunctionCallbackNative
Link copied to clipboard

Callback to create data for tile.

class FetchTileFunctionCallbackNative : FetchTileFunctionCallback
class FetchTileFunctionCallbackNative : FetchTileFunctionCallback
class FetchTileFunctionCallbackNative : FetchTileFunctionCallback
FreeCameraOptions
Link copied to clipboard

Various options for accessing physical properties of the underlying camera entity. A direct access to these properties allows more flexible and precise controlling of the camera while also being fully compatible and interchangeable with CameraOptions. All fields are optional.

class FreeCameraOptions
class FreeCameraOptions
class FreeCameraOptions
GlyphsRasterizationMode
Link copied to clipboard

Describes glyphs rasterization modes.

enum GlyphsRasterizationMode
enum GlyphsRasterizationMode
enum GlyphsRasterizationMode
GlyphsRasterizationOptions
Link copied to clipboard

Describes the glyphs rasterization option values.

class GlyphsRasterizationOptions : Serializable
class GlyphsRasterizationOptions : Serializable
class GlyphsRasterizationOptions : Serializable
Image
Link copied to clipboard

Image type.

class Image : Serializable
class Image : Serializable
class Image : Serializable
ImageContent
Link copied to clipboard

Describes the image content, e.g. where text can be fit into an image. When sizing icons with `icon-text-fit`, the icon size will be adjusted so that the this content box fits exactly around the text.

class ImageContent : Serializable
class ImageContent : Serializable
class ImageContent : Serializable
ImageStretches
Link copied to clipboard

Describes the image stretch areas.

class ImageStretches : Serializable
class ImageStretches : Serializable
class ImageStretches : Serializable
LayerPosition
Link copied to clipboard

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

class LayerPosition : Serializable
class LayerPosition : Serializable
class LayerPosition : Serializable
Map
Link copied to clipboard

Map class provides map rendering functionality.

class Map : CameraManager, MapInterface
class Map : CameraManager, MapInterface
class Map : CameraManager, MapInterface
MapboxConfigurationException
Link copied to clipboard

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

class MapboxConfigurationException : RuntimeException
MapboxExperimental
Link copied to clipboard

Annotation class to mark API as experimental.

annotation class MapboxExperimental
MapboxLifecycleObserver
Link copied to clipboard

MapboxLifecycleObserver interface defines the lifecycle events that needed by MapView.

interface MapboxLifecycleObserver
MapboxMap
Link copied to clipboard

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.

Note: Similar to a View object, a MapboxMap should only be read and modified from the main thread.

MapClient
Link copied to clipboard

Interface for the MapClient.

interface MapClient
interface MapClient
interface MapClient
MapClientNative
Link copied to clipboard

Interface for the MapClient.

class MapClientNative : MapClient
class MapClientNative : MapClient
class MapClientNative : MapClient
MapConstants
Link copied to clipboard

Collection of useful constants.

class MapConstants
class MapConstants
class MapConstants
MapControllable
Link copied to clipboard

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

interface MapControllable : MapboxLifecycleObserver
MapDebugOptions
Link copied to clipboard

Options for enabling debugging features in a map.

enum MapDebugOptions
enum MapDebugOptions
enum MapDebugOptions
MapEvents
Link copied to clipboard

List of supported event types by the `map` and `map snapshotter` objects, and event data format specification for each event. ``` text Simplified diagram for events emitted by the map object. ┌─────────────┐ ┌─────────┐ ┌──────────────┐ │ Application │ │ Map │ │ResourceLoader│ └──────┬──────┘ └────┬────┘ └───────┬──────┘ │ │ │ ├───────setStyleURI────────▶│ │ │ ├───────────get style───────────▶│ │ │ │ │ │◀─────────style data────────────┤ │ │ │ │ ├─parse style─┐ │ │ │ │ │ │ StyleDataLoaded ◀─────────────┘ │ │◀──── { "type": "style" } ─────┤ │ │ ├─────────get sprite────────────▶│ │ │ │ │ │◀────────sprite data────────────┤ │ │ │ │ ├──────parse sprite───────┐ │ │ │ │ │ │ StyleDataLoaded ◀─────────────────────────┘ │ │◀─── { "type": "sprite" } ─────┤ │ │ ├─────get source TileJSON(s)────▶│ │ │ │ │ SourceDataLoaded │◀─────parse TileJSON data───────┤ │◀── { "type": "metadata" } ────┤ │ │ │ │ │ │ │ │ StyleDataLoaded │ │ │◀─── { "type": "sources" } ────┤ │ │ ├──────────get tiles────────────▶│ │ │ │ │◀───────StyleLoaded────────┤ │ │ │ │ │ SourceDataLoaded │◀─────────tile data─────────────┤ │◀──── { "type": "tile" } ──────┤ │ │ │ │ │ │ │ │◀────RenderFrameStarted────┤ │ │ ├─────render─────┐ │ │ │ │ │ │ ◀────────────────┘ │ │◀───RenderFrameFinished────┤ │ │ ├──render, all tiles loaded──┐ │ │ │ │ │ │ ◀────────────────────────────┘ │ │◀────────MapLoaded─────────┤ │ │ │ │ │ │ │ │◀─────────MapIdle──────────┤ │ │ ┌ ─── ─┴─ ─── ┐ │ │ │ offline │ │ │ └ ─── ─┬─ ─── ┘ │ │ │ │ ├─────────setCamera────────▶│ │ │ ├───────────get tiles───────────▶│ │ │ │ │ │┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ │◀─────────MapIdle──────────┤ waiting for connectivity │ │ │ ││ Map renders cached data │ │ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ │ │ │ │ ```

class MapEvents
class MapEvents
class MapEvents
MapInitOptions
Link copied to clipboard

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.

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

Map class provides map rendering functionality.

interface MapInterface : CameraManagerInterface
interface MapInterface : CameraManagerInterface
interface MapInterface : CameraManagerInterface
MapOptions
Link copied to clipboard

Describes the map option values.

class MapOptions : Serializable
class MapOptions : Serializable
class MapOptions : Serializable
MapSnapshot
Link copied to clipboard

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

class MapSnapshot : MapSnapshotInterface
class MapSnapshot : MapSnapshotInterface
class MapSnapshot : MapSnapshotInterface
MapSnapshotInterface
Link copied to clipboard

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

interface MapSnapshotInterface
interface MapSnapshotInterface
interface MapSnapshotInterface
MapSnapshotOptions
Link copied to clipboard

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

class MapSnapshotOptions : Serializable
class MapSnapshotOptions : Serializable
class MapSnapshotOptions : Serializable
MapSnapshotter
Link copied to clipboard

MapSnapshotter exposes functionality to capture static map images.

class MapSnapshotter : CameraManager, MapSnapshotterInterface
class MapSnapshotter : CameraManager, MapSnapshotterInterface
class MapSnapshotter : CameraManager, MapSnapshotterInterface
MapSnapshotterInterface
Link copied to clipboard

MapSnapshotter exposes functionality to capture static map images.

interface MapSnapshotterInterface : CameraManagerInterface
interface MapSnapshotterInterface : CameraManagerInterface
interface MapSnapshotterInterface : CameraManagerInterface
MapSurface
Link copied to clipboard

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.

Use of MapSurface requires a Mapbox API access token. Obtain an access token on the Mapbox account page.

<strong>Warning:</strong> Please note that you are responsible for getting permission to use the map data, and for ensuring your use adheres to the relevant terms of use.

class MapSurface @JvmOverloads() constructor(context: Context, surface: Surface, mapInitOptions: MapInitOptions) : MapPluginProviderDelegate, MapControllable
MapView
Link copied to clipboard

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.

Use of MapView requires a Mapbox API access token. Obtain an access token on the Mapbox account page.

<strong>Warning:</strong> Please note that you are responsible for getting permission to use the map data, and for ensuring your use adheres to the relevant terms of use.

open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable
MercatorCoordinate
Link copied to clipboard

Describes a point on the map in Mercator projection.

class MercatorCoordinate : Serializable
class MercatorCoordinate : Serializable
class MercatorCoordinate : Serializable
NorthOrientation
Link copied to clipboard

Describes the map orientation.

enum NorthOrientation
enum NorthOrientation
enum NorthOrientation
Observable
Link copied to clipboard

The `observable` interface provides basic Publish&Subscribe functionality. Classes that extend this functionality and capable of generating events, have to specify event types and corresponding data format for an event.

open class Observable : ObservableInterface
open class Observable : ObservableInterface
open class Observable : ObservableInterface
ObservableInterface
Link copied to clipboard

The `observable` interface provides basic Publish&Subscribe functionality. Classes that extend this functionality and capable of generating events, have to specify event types and corresponding data format for an event.

interface ObservableInterface
interface ObservableInterface
interface ObservableInterface
Observer
Link copied to clipboard

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

interface Observer
interface Observer
interface Observer
ObserverNative
Link copied to clipboard

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

class ObserverNative : Observer
class ObserverNative : Observer
class ObserverNative : Observer
OfflineDatabaseMergeCallback
Link copied to clipboard

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

interface OfflineDatabaseMergeCallback
interface OfflineDatabaseMergeCallback
interface OfflineDatabaseMergeCallback
OfflineDatabaseMergeCallbackNative
Link copied to clipboard

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

OfflineManager
Link copied to clipboard

An `offline manager` manages downloads and storage for style packages and also produces tileset descriptors for the `tile store`. All the asynchronous methods calls complete even if the `offline manager` instance gets out of scope before.

class OfflineManager : OfflineManagerInterface
class OfflineManager : OfflineManagerInterface
class OfflineManager : OfflineManagerInterface
OfflineManagerInterface
Link copied to clipboard

An `offline manager` manages downloads and storage for style packages and also produces tileset descriptors for the `tile store`. All the asynchronous methods calls complete even if the `offline manager` instance gets out of scope before.

interface OfflineManagerInterface
interface OfflineManagerInterface
interface OfflineManagerInterface
OfflineRegion
Link copied to clipboard

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

class OfflineRegion : OfflineRegionInterface
class OfflineRegion : OfflineRegionInterface
class OfflineRegion : OfflineRegionInterface
OfflineRegionCallback
Link copied to clipboard

Callback invoked when fetching existing regions.

interface OfflineRegionCallback
interface OfflineRegionCallback
interface OfflineRegionCallback
OfflineRegionCallbackNative
Link copied to clipboard

Callback invoked when fetching existing regions.

class OfflineRegionCallbackNative : OfflineRegionCallback
class OfflineRegionCallbackNative : OfflineRegionCallback
class OfflineRegionCallbackNative : OfflineRegionCallback
OfflineRegionCreateCallback
Link copied to clipboard

Callback invoked when creating a new region.

interface OfflineRegionCreateCallback
interface OfflineRegionCreateCallback
interface OfflineRegionCreateCallback
OfflineRegionCreateCallbackNative
Link copied to clipboard

Callback invoked when creating a new region.

OfflineRegionDownloadState
Link copied to clipboard

Describes the download state of a region.

enum OfflineRegionDownloadState
enum OfflineRegionDownloadState
enum OfflineRegionDownloadState
OfflineRegionGeometryDefinition
Link copied to clipboard

An offline region definition is a geographic region defined by a style URL, a geometry, zoom range, and device pixel ratio. Both `minZoom` and `maxZoom` must be ≥ 0, and `maxZoom` must be ≥ `minZoom`. The `maxZoom` may be ∞, in which case for each tile source, the region will include tiles from `minZoom` up to the maximum zoom level provided by that source. The `pixelRatio` must be ≥ 0 and should typically be 1.0 or 2.0.

class OfflineRegionGeometryDefinition : Serializable
class OfflineRegionGeometryDefinition : Serializable
class OfflineRegionGeometryDefinition : Serializable
OfflineRegionInterface
Link copied to clipboard

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

interface OfflineRegionInterface
interface OfflineRegionInterface
interface OfflineRegionInterface
OfflineRegionManager
Link copied to clipboard

The `offline region manager` that manages offline packs. All of the class’s instance methods are asynchronous reflecting the fact that offline resources are stored in a database. The offline manager maintains a canonical collection of offline packs.

class OfflineRegionManager : OfflineRegionManagerInterface
class OfflineRegionManager : OfflineRegionManagerInterface
class OfflineRegionManager : OfflineRegionManagerInterface
OfflineRegionManagerInterface
Link copied to clipboard

The `offline region manager` that manages offline packs. All of the class’s instance methods are asynchronous reflecting the fact that offline resources are stored in a database. The offline manager maintains a canonical collection of offline packs.

interface OfflineRegionManagerInterface
interface OfflineRegionManagerInterface
interface OfflineRegionManagerInterface
OfflineRegionObserver
Link copied to clipboard

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

interface OfflineRegionObserver
interface OfflineRegionObserver
interface OfflineRegionObserver
OfflineRegionObserverNative
Link copied to clipboard

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

class OfflineRegionObserverNative : OfflineRegionObserver
class OfflineRegionObserverNative : OfflineRegionObserver
class OfflineRegionObserverNative : OfflineRegionObserver
OfflineRegionStatus
Link copied to clipboard

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. Note that the total required size in bytes is not currently available. A future API release may provide an estimate of this number.

class OfflineRegionStatus : Serializable
class OfflineRegionStatus : Serializable
class OfflineRegionStatus : Serializable
OfflineRegionTilePyramidDefinition
Link copied to clipboard

An offline region definition is a geographic region defined by a style URL, geographic bounding box, zoom range, and device pixel ratio. Both `minZoom` and `maxZoom` must be ≥ 0, and `maxZoom` must be ≥ `minZoom`. The `maxZoom` may be ∞, in which case for each tile source, the region will include tiles from `minZoom` up to the maximum zoom level provided by that source. The `pixelRatio` must be ≥ 0 and should typically be 1.0 or 2.0.

class OfflineRegionTilePyramidDefinition : Serializable
class OfflineRegionTilePyramidDefinition : Serializable
class OfflineRegionTilePyramidDefinition : Serializable
ProjectedMeters
Link copied to clipboard

ProjectedMeters is a coordinate in a specific [Spherical Mercator](http://docs.openlayers.org/library/spherical_mercator.html) projection. This specific Spherical Mercator projection assumes the Earth is a sphere with a radius of 6,378,137 meters. Coordinates are determined as distances, in meters, on the surface of that sphere.

class ProjectedMeters : Serializable
class ProjectedMeters : Serializable
class ProjectedMeters : Serializable
Projection
Link copied to clipboard

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

class Projection
class Projection
class Projection
QueriedFeature
Link copied to clipboard

Represents query result that is returned in QueryFeaturesCallback.

class QueriedFeature : Serializable
class QueriedFeature : Serializable
class QueriedFeature : Serializable
QueryFeatureExtensionCallback
Link copied to clipboard

Callback to get query feature extension asynchronously.

interface QueryFeatureExtensionCallback
interface QueryFeatureExtensionCallback
interface QueryFeatureExtensionCallback
QueryFeatureExtensionCallbackNative
Link copied to clipboard

Callback to get query feature extension asynchronously.

QueryFeaturesCallback
Link copied to clipboard

Callback to get query features asynchronously.

interface QueryFeaturesCallback
interface QueryFeaturesCallback
interface QueryFeaturesCallback
QueryFeaturesCallbackNative
Link copied to clipboard

Callback to get query features asynchronously.

class QueryFeaturesCallbackNative : QueryFeaturesCallback
class QueryFeaturesCallbackNative : QueryFeaturesCallback
class QueryFeaturesCallbackNative : QueryFeaturesCallback
QueryFeatureStateCallback
Link copied to clipboard

Callback to get query features asynchronously.

interface QueryFeatureStateCallback
interface QueryFeatureStateCallback
interface QueryFeatureStateCallback
QueryFeatureStateCallbackNative
Link copied to clipboard

Callback to get query features asynchronously.

class QueryFeatureStateCallbackNative : QueryFeatureStateCallback
class QueryFeatureStateCallbackNative : QueryFeatureStateCallback
class QueryFeatureStateCallbackNative : QueryFeatureStateCallback
RenderCacheOptions
Link copied to clipboard

Parameters that defines behavior of the render cache.

class RenderCacheOptions : Serializable
class RenderCacheOptions : Serializable
class RenderCacheOptions : Serializable
RenderedQueryOptions
Link copied to clipboard

Options for querying rendered features.

class RenderedQueryOptions : Serializable
class RenderedQueryOptions : Serializable
class RenderedQueryOptions : Serializable
ResourceOptions
Link copied to clipboard

Options to configure a resource

class ResourceOptions : Serializable
class ResourceOptions : Serializable
class ResourceOptions : Serializable
ResourceOptionsManager
Link copied to clipboard

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

data class ResourceOptionsManager(resourceOptions: ResourceOptions)
ResponseError
Link copied to clipboard

Describes an offline request response error.

class ResponseError : Serializable
class ResponseError : Serializable
class ResponseError : Serializable
ResponseErrorReason
Link copied to clipboard

Describes the reason for an offline request response error.

enum ResponseErrorReason
enum ResponseErrorReason
enum ResponseErrorReason
ScreenBox
Link copied to clipboard

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

class ScreenBox : Serializable
class ScreenBox : Serializable
class ScreenBox : Serializable
ScreenCoordinate
Link copied to clipboard

Describes the coordinate on the screen, measured from top to bottom and from left to right. Note: the `map` uses screen coordinate units measured in `platform pixels`.

class ScreenCoordinate : Serializable
class ScreenCoordinate : Serializable
class ScreenCoordinate : Serializable
Settings
Link copied to clipboard

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

class Settings
class Settings
class Settings
Size
Link copied to clipboard

Size type.

class Size : Serializable
class Size : Serializable
class Size : Serializable
SnapshotCompleteCallback
Link copied to clipboard

Callback invoked once a snapshot operation completes.

interface SnapshotCompleteCallback
interface SnapshotCompleteCallback
interface SnapshotCompleteCallback
SnapshotCompleteCallbackNative
Link copied to clipboard

Callback invoked once a snapshot operation completes.

class SnapshotCompleteCallbackNative : SnapshotCompleteCallback
class SnapshotCompleteCallbackNative : SnapshotCompleteCallback
class SnapshotCompleteCallbackNative : SnapshotCompleteCallback
SnapshotCreatedListener
Link copied to clipboard

Interface for getting snapshot when it's finished.

fun fun interface SnapshotCreatedListener
SnapshotOverlayOptions
Link copied to clipboard

Data class to config the overlays on the snapshotter

data class SnapshotOverlayOptions @JvmOverloads() constructor(showLogo: Boolean, showAttributes: Boolean)
SnapshotStyleListener
Link copied to clipboard

Interface for getting all style related events for snapshotter.

interface SnapshotStyleListener
Snapshotter
Link copied to clipboard

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

open class Snapshotter
SourceQueryOptions
Link copied to clipboard

Options for querying source features.

class SourceQueryOptions : Serializable
class SourceQueryOptions : Serializable
class SourceQueryOptions : Serializable
Style
Link copied to clipboard

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 getStyleAsync() method on MapboxMap.

Note: Similar to a View object, a Style should only be read and modified from the main thread.

class Style : StyleInterface
StyleManager
Link copied to clipboard

Interface for managing style of the `map`.

open class StyleManager : Observable, StyleManagerInterface
open class StyleManager : Observable, StyleManagerInterface
open class StyleManager : Observable, StyleManagerInterface
StyleManagerInterface
Link copied to clipboard

Interface for managing style of the `map`.

interface StyleManagerInterface : ObservableInterface
interface StyleManagerInterface : ObservableInterface
interface StyleManagerInterface : ObservableInterface
StyleObjectInfo
Link copied to clipboard

The information about style object (source or layer).

class StyleObjectInfo : Serializable
class StyleObjectInfo : Serializable
class StyleObjectInfo : Serializable
StylePack
Link copied to clipboard

The `style pack` represents a stored style package.

class StylePack : Serializable
class StylePack : Serializable
class StylePack : Serializable
StylePackCallback
Link copied to clipboard

Callback invoked when returning a style package.

interface StylePackCallback
interface StylePackCallback
interface StylePackCallback
StylePackCallbackNative
Link copied to clipboard

Callback invoked when returning a style package.

class StylePackCallbackNative : StylePackCallback
class StylePackCallbackNative : StylePackCallback
class StylePackCallbackNative : StylePackCallback
StylePackError
Link copied to clipboard

Describes a style package load request error.

open class StylePackError : Serializable
open class StylePackError : Serializable
open class StylePackError : Serializable
StylePackErrorType
Link copied to clipboard

Describes the reason for a style package download request failure.

enum StylePackErrorType
enum StylePackErrorType
enum StylePackErrorType
StylePackLoadOptions
Link copied to clipboard

Describes the style package load option values.

class StylePackLoadOptions : Serializable
class StylePackLoadOptions : Serializable
class StylePackLoadOptions : Serializable
StylePackLoadProgress
Link copied to clipboard

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.

class StylePackLoadProgress : Serializable
class StylePackLoadProgress : Serializable
class StylePackLoadProgress : Serializable
StylePackLoadProgressCallback
Link copied to clipboard

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

interface StylePackLoadProgressCallback
interface StylePackLoadProgressCallback
interface StylePackLoadProgressCallback
StylePackLoadProgressCallbackNative
Link copied to clipboard

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

StylePackMetadataCallback
Link copied to clipboard

Callback invoked to return a style package's associated metadata

interface StylePackMetadataCallback
interface StylePackMetadataCallback
interface StylePackMetadataCallback
StylePackMetadataCallbackNative
Link copied to clipboard

Callback invoked to return a style package's associated metadata

class StylePackMetadataCallbackNative : StylePackMetadataCallback
class StylePackMetadataCallbackNative : StylePackMetadataCallback
class StylePackMetadataCallbackNative : StylePackMetadataCallback
StylePacksCallback
Link copied to clipboard

Callback invoked when returning existing style packages.

interface StylePacksCallback
interface StylePacksCallback
interface StylePacksCallback
StylePacksCallbackNative
Link copied to clipboard

Callback invoked when returning existing style packages.

class StylePacksCallbackNative : StylePacksCallback
class StylePacksCallbackNative : StylePacksCallback
class StylePacksCallbackNative : StylePacksCallback
StylePropertyValue
Link copied to clipboard

Holds a style property value with meta data.

class StylePropertyValue : Serializable
class StylePropertyValue : Serializable
class StylePropertyValue : Serializable
StylePropertyValueKind
Link copied to clipboard

Describes the kind of a style property value.

enum StylePropertyValueKind
enum StylePropertyValueKind
enum StylePropertyValueKind
Task
Link copied to clipboard

Task to be executed on client's scheduling system.

interface Task
interface Task
interface Task
TaskNative
Link copied to clipboard

Task to be executed on client's scheduling system.

class TaskNative : Task
class TaskNative : Task
class TaskNative : Task
TileOptions
Link copied to clipboard

Options for custom geometry tiles.

class TileOptions : Serializable
class TileOptions : Serializable
class TileOptions : Serializable
TilesetDescriptorOptions
Link copied to clipboard

Describes the style package load option values.

class TilesetDescriptorOptions : Serializable
class TilesetDescriptorOptions : Serializable
class TilesetDescriptorOptions : Serializable
TileStoreUsageMode
Link copied to clipboard

Describes tile store usage modes.

enum TileStoreUsageMode
enum TileStoreUsageMode
enum TileStoreUsageMode
TransitionOptions
Link copied to clipboard

The `transition options` controls timing for the interpolation between a transitionable style property's previous value and new value. These can be used to define the style default property transition behavior. Also, any transitionable style property may also have its own `-transition` property that defines specific transition timing for that specific layer property, overriding the global transition values.

class TransitionOptions : Serializable
class TransitionOptions : Serializable
class TransitionOptions : Serializable
Vec3
Link copied to clipboard

3 component vector.

class Vec3 : Serializable
class Vec3 : Serializable
class Vec3 : Serializable
Vec4
Link copied to clipboard

4 component vector.

class Vec4 : Serializable
class Vec4 : Serializable
class Vec4 : Serializable
ViewportMode
Link copied to clipboard

Satisfies embedding platforms that requires the viewport coordinate systems to be set according to its standards.

enum ViewportMode
enum ViewportMode
enum ViewportMode

Functions

applyDefaultParams
Link copied to clipboard

Get a default MapOptions.Builder with reasterization mode GlyphsRasterizationMode#ALL_GLYPHS_RASTERIZED_LOCALLY

fun MapOptions.Builder.applyDefaultParams(context: Context): MapOptions.Builder

Get a default ResourceOptions.Builder with Mapbox pre-defined options, and with the access token taken from the Android resources(if available).

bitmap
Link copied to clipboard

Extension function to obtain Bitmap from snapshotter converted from Image.

fun MapSnapshotInterface.bitmap(): Bitmap
setDisabled
Link copied to clipboard

Set render cache size to 0MB in order to disable it.

setLargeSize
Link copied to clipboard

Set render cache size to large(128MB).

Works best with devices powerful GPUs, or devices with pixel ratio 1.0.

setSmallSize
Link copied to clipboard

Set render cache size to small(64MB).

Works best with devices with not so powerful GPUs, or devices with pixel ratio of 1.0.

toCameraOptions
Link copied to clipboard

Extension function to convert CameraState to CameraOptions.

If anchor is specified - CameraOptions.center will be explicitly set to NULL in order for the anchor to apply to the map camera.

fun CameraState.toCameraOptions(anchor: ScreenCoordinate?): CameraOptions

Properties

MAPBOX_ACCESS_TOKEN_RESOURCE_NAME
Link copied to clipboard

Resource name used to lookup the Mapbox access token.

const val MAPBOX_ACCESS_TOKEN_RESOURCE_NAME: String
MAPBOX_LOCALE
Link copied to clipboard

Default Locale for data processing (ex: String.toLowerCase(com.mapbox.maps.getMAPBOX_LOCALE, "foo"))

val MAPBOX_LOCALE: Locale