Mapbox class abstract

Annotations
  • @JS('mapboxgl')

Constructors

Mapbox()

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 Properties

accessToken ↔ String
Gets and sets the map's access token.
getter/setter pair
baseApiUrl ↔ String
Gets and sets the map's default API URL for requesting tiles, styles, sprites, and glyphs
getter/setter pair
maxParallelImageRequests ↔ num
Gets and sets the maximum number of images (raster tiles, sprites, icons) to load in parallel, which affects performance in raster-heavy maps. 16 by default.
getter/setter pair
version → String
The version of Mapbox GL JS in use as specified in package.json, CHANGELOG.md, and the GitHub release.
no setter
workerCount ↔ num
Gets and sets the number of web workers instantiated on a page with GL JS maps. By default, it is set to half the number of CPU cores (capped at 6). Make sure to set this property before creating any map instances for it to have effect.
getter/setter pair

Static Methods

clearStorage(dynamic f(Error e)) → void
Clears browser storage used by this library. Using this method flushes the Mapbox tile cache that is managed by this library. Tiles may still be cached by the browser in some cases.
getRTLTextPluginStatus() → String
Gets the map's RTL text plugin status. The status can be unavailable (i.e. not requested or removed), loading, loaded or error. If the status is loaded and the plugin is requested again, an error will be thrown.
setRTLTextPlugin(String pluginURL, Function callback, bool lazy) → void
Sets the map's RTL text plugin. Necessary for supporting the Arabic and Hebrew languages, which are written right-to-left. Mapbox Studio loads this plugin by default.
supported(bool failIfMajorPerformanceCaveat) → bool
Test whether the browser supports Mapbox GL JS.