MapboxMapsOptions class final

Configurations for the external resources that are used by Maps API object, such as maps data directory and base URL.

The Maps API objects include instances of Map, Snapshotter, OfflineManager and OfflineRegionManager classes.

The resource options changes are taken into consideration by the Maps API objects during their construction phase. Any changes made to the resource options during runtime will not impact objects that have already been created.

Every resource option has a default value, which does not have to be overridden by the client most of the time. If the default resource options need to be overridden, it is recommended to do it once at the application start and before any of the Maps API objects are constructed. Although it is technically possible to run Maps API objects that use different resource options, such a setup might cause performance implications.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

getAssetPath() → Future<String>

The path to the Maps asset folder. Default is application's main bundle path.

getBaseUrl() → Future<String>

The base URL that would be used by the Maps engine to make HTTP requests. By default the engine uses the base URL https://api.mapbox.com

getDataPath() → Future<String>

The path to the Maps data folder.

getLanguage() → Future<String?>

Current language preference for Mapbox products.

getTileStoreUsageMode() → Future<TileStoreUsageMode>

The tile store usage mode for the Maps API objects. Default is readOnly.

getWorldview() → Future<String?>

Current worldview preference for Mapbox products.

setAssetPath(String path) → void

The path to the Maps asset folder. Default is application's main bundle path.

setBaseUrl(String url) → void

The base URL that would be used by the Maps engine to make HTTP requests.

setDataPath(String path) → void

The path to the Maps data folder.

setLanguage(String? language) → void

Set preferred language for Mapbox products with a bcp-47 tag.

setTileStoreUsageMode(TileStoreUsageMode mode) → void

The tile store usage mode for the Maps API objects.

setWorldview(String? worldview) → void

Set preferred worldview for Mapbox products as a ISO 3166-1 alpha-2 country code.