MapboxMapsOptions class final

Configurations for the external resources used by Maps API objects (Map, Snapshotter, OfflineManager, OfflineRegionManager).

Resource option changes are read at construction time. Apply them once at startup, before any Maps API objects are constructed.

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

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

clearData() Future<void>
Clears all temporary map data from the data path.
getAssetPath() Future<String>
Path to the Maps asset folder. Ignored on Android.
getBaseUrl() Future<String>
Base URL used by the Maps engine for HTTP requests (default https://api.mapbox.com).
getDataPath() Future<String>
Path to the Maps data folder (offline style packages, temporary data).
getFlutterAssetPath(String? flutterAssetUri) Future<String?>
Resolves a Flutter asset URI to a platform-native path usable by the Maps runtime.
getLanguage() Future<String?>
Language preference (BCP-47 tag), if set.
getTileStoreUsageMode() Future<TileStoreUsageMode>
Tile store usage mode (default readOnly).
getWorldview() Future<String?>
Worldview preference (ISO 3166-1 alpha-2 country code), if set.
setAssetPath(String path) → void
Sets the path to the Maps asset folder.
setBaseUrl(String url) → void
Sets the base URL used by the Maps engine.
setDataPath(String path) → void
Sets the path to the Maps data folder.
setLanguage(String? language) → void
Sets the language preference (BCP-47 tag).
setTileStoreUsageMode(TileStoreUsageMode mode) → void
Sets the tile store usage mode.
setWorldview(String? worldview) → void
Sets the worldview preference (ISO 3166-1 alpha-2 country code).