MapboxStyleImageryProvider

new Cesium.MapboxStyleImageryProvider(options)
Scene/MapboxStyleImageryProvider.js 56

Provides tiled imagery hosted by Mapbox.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
url Resource | String 'https://api.mapbox.com/styles/v1/' optional The Mapbox server url.
username String 'mapbox' optional The username of the map account.
styleId String The Mapbox Style ID.
accessToken String optional The public access token for the imagery.
tilesize Number 512 optional The size of the image tiles.
scaleFactor Boolean optional Determines if tiles are rendered at a @2x scale factor.
ellipsoid Ellipsoid optional The ellipsoid. If not specified, the WGS84 ellipsoid is used.
minimumLevel Number 0 optional The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
maximumLevel Number optional The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
rectangle Rectangle Rectangle.MAX_VALUE optional The rectangle, in radians, covered by the image.
credit Credit | String optional A credit for the data source, which is displayed on the canvas.
Example:
// Mapbox style provider
var mapbox = new Cesium.MapboxStyleImageryProvider({
    styleId: 'streets-v11',
    accessToken: 'thisIsMyAccessToken'
});
See:

Members

readonlycredit : Credit
Scene/MapboxStyleImageryProvider.js 275

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlyerrorEvent : Event
Scene/MapboxStyleImageryProvider.js 261

Gets an event that is raised when the imagery provider encounters an asynchronous error.. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

readonlyhasAlphaChannel : Boolean
Scene/MapboxStyleImageryProvider.js 303

Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are reduced.

readonlymaximumLevel : Number
Scene/MapboxStyleImageryProvider.js 202

Gets the maximum level-of-detail that can be requested. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlyminimumLevel : Number
Scene/MapboxStyleImageryProvider.js 219

Gets the minimum level-of-detail that can be requested. This function should not be called before MapboxStyleImageryProvider#ready returns true. Generally, a minimum level should only be used when the rectangle of the imagery is small enough that the number of tiles at the minimum level is small. An imagery provider with more than a few tiles at the minimum level will lead to rendering problems.

readonlyproxy : Proxy
Scene/MapboxStyleImageryProvider.js 287

Gets the proxy used by this provider.

readonlyready : Boolean
Scene/MapboxStyleImageryProvider.js 138

Gets a value indicating whether or not the provider is ready for use.

readonlyreadyPromise : Promise.<Boolean>
Scene/MapboxStyleImageryProvider.js 150

Gets a promise that resolves to true when the provider is ready for use.

readonlyrectangle : Rectangle
Scene/MapboxStyleImageryProvider.js 163

Gets the rectangle, in radians, of the imagery provided by the instance. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlytileDiscardPolicy : TileDiscardPolicy
Scene/MapboxStyleImageryProvider.js 247

Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlytileHeight : Number
Scene/MapboxStyleImageryProvider.js 189

Gets the height of each tile, in pixels. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlytileWidth : Number
Scene/MapboxStyleImageryProvider.js 176

Gets the width of each tile, in pixels. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlytilingScheme : TilingScheme
Scene/MapboxStyleImageryProvider.js 232

Gets the tiling scheme used by the provider. This function should not be called before MapboxStyleImageryProvider#ready returns true.

readonlyurl : String
Scene/MapboxStyleImageryProvider.js 126

Gets the URL of the Mapbox server.

Methods

getTileCredits(x, y, level) → Array.<Credit>
Scene/MapboxStyleImageryProvider.js 320

Gets the credits to be displayed when a given tile is displayed.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level;
Returns:
The credits to be displayed when the tile is displayed.
Throws:
  • DeveloperError : getTileCredits must not be called before the imagery provider is ready.

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Scene/MapboxStyleImageryProvider.js 363

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before MapboxStyleImageryProvider#ready returns true. This function is optional, so it may not exist on all ImageryProviders.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
longitude Number The longitude at which to pick features.
latitude Number The latitude at which to pick features.
Returns:
A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of ImageryLayerFeatureInfo instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.
Throws:
  • DeveloperError : pickFeatures must not be called before the imagery provider is ready.

requestImage(x, y, level, request) → Promise.<(Image|Canvas)>|undefined
Scene/MapboxStyleImageryProvider.js 341

Requests the image for a given tile. This function should not be called before MapboxStyleImageryProvider#ready returns true.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
request Request optional The request object. Intended for internal use only.
Returns:
A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later. The resolved image may be either an Image or a Canvas DOM object.
Throws:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.