Package com.mapbox.maps

Callback invoked once an asynchronous operation completes.

Callback invoked once an asynchronous operation completes.

Holds information about `camera bounds`.

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

Interface for managing camera.

Interface for managing camera.

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.

Describes the viewpoint of a camera.

Callback to cancel a tile.

Callback to cancel a tile.

Represents a tile coordinate.

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

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

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

A coordinate bounds and zoom.

Options for custom geometry source.

Interface for hosting a custom map style layer.

Interface for hosting a custom map style layer.

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

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

Interface that provides access to elevation data.

Interface that provides access to elevation data.

Generic Event type used to notify an `observer`.

A value or a collection of a feature extension.

Callback to create data for tile.

Callback to create data for tile.

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.

Describes glyphs rasterization modes.

Describes the glyphs rasterization option values.

Image type.

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.

Describes the image stretch areas.

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

Map class provides map rendering functionality.

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

Annotation class to mark API as experimental.

MapboxLifecycleObserver interface defines the lifecycle events that needed by MapView.

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.

Interface for the MapClient.

Interface for the MapClient.

Collection of useful constants.

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

Options for enabling debugging features in a map.

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 │ │ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ │ │ │ │ ```

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.

Map class provides map rendering functionality.

Describes the map option values.

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

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

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

MapSnapshotter exposes functionality to capture static map images.

MapSnapshotter exposes functionality to capture static map images.

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.

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.

Describes a point on the map in Mercator projection.

Describes the map orientation.

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.

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.

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

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

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

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

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.

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.

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

Callback invoked when fetching existing regions.

Callback invoked when fetching existing regions.

Callback invoked when creating a new region.

Callback invoked when creating a new region.

Describes the download state of a region.

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.

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

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.

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.

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

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

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.

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.

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.

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

Represents query result that is returned in QueryFeaturesCallback.

Callback to get query feature extension asynchronously.

Callback to get query feature extension asynchronously.

Callback to get query features asynchronously.

Callback to get query features asynchronously.

Callback to get query features asynchronously.

Callback to get query features asynchronously.

Parameters that defines behavior of the render cache.

Options for querying rendered features.

Options to configure a resource

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

Describes an offline request response error.

Describes the reason for an offline request response error.

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

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

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

Size type.

Callback invoked once a snapshot operation completes.

Callback invoked once a snapshot operation completes.

Interface for getting snapshot when it's finished.

Data class to config the overlays on the snapshotter

Interface for getting all style related events for snapshotter.

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

Options for querying source features.

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.

Interface for managing style of the `map`.

Interface for managing style of the `map`.

The information about style object (source or layer).

The `style pack` represents a stored style package.

Callback invoked when returning a style package.

Callback invoked when returning a style package.

Describes a style package load request error.

Describes the reason for a style package download request failure.

Describes the style package load option values.

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.

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

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

Callback invoked to return a style package's associated metadata

Callback invoked to return a style package's associated metadata

Callback invoked when returning existing style packages.

Callback invoked when returning existing style packages.

Holds a style property value with meta data.

Describes the kind of a style property value.

Task to be executed on client's scheduling system.

Task to be executed on client's scheduling system.

Options for custom geometry tiles.

Describes the style package load option values.

Describes tile store usage modes.

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.

3 component vector.

4 component vector.

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

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

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

Extension function to obtain Bitmap from snapshotter converted from Image.

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

Set render cache size to large(128MB).

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

Set render cache size to small(64MB).

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

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.