new MapboxImageryProvider(optionsopt)
Provides tiled imagery hosted by Mapbox.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
Object with the following properties:
Properties
|
- Source:
- See:
Example
// Mapbox tile provider
var mapbox = new Cesium.MapboxImageryProvider({
mapId: 'mapbox.streets',
accessToken: 'thisIsMyAccessToken'
});
Members
(readonly) credit :Credit
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
MapboxImageryProvider#ready
returns true.
Type:
- Source:
(readonly) errorEvent :Event
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
.
Type:
- Source:
(readonly) hasAlphaChannel :Boolean
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.
Type:
- Boolean
- Source:
(readonly) maximumLevel :Number
Gets the maximum level-of-detail that can be requested. This function should
not be called before
MapboxImageryProvider#ready
returns true.
Type:
- Number
- Source:
(readonly) minimumLevel :Number
Gets the minimum level-of-detail that can be requested. This function should
not be called before
MapboxImageryProvider#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.
Type:
- Number
- Source:
(readonly) proxy :Proxy
Gets the proxy used by this provider.
Type:
- Proxy
- Source:
(readonly) ready :Boolean
Gets a value indicating whether or not the provider is ready for use.
Type:
- Boolean
- Source:
(readonly) readyPromise :Promise.<Boolean>
Gets a promise that resolves to true when the provider is ready for use.
Type:
- Promise.<Boolean>
- Source:
(readonly) rectangle :Rectangle
Gets the rectangle, in radians, of the imagery provided by the instance. This function should
not be called before
MapboxImageryProvider#ready
returns true.
Type:
- Source:
(readonly) tileDiscardPolicy :TileDiscardPolicy
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
MapboxImageryProvider#ready
returns true.
Type:
- Source:
(readonly) tileHeight :Number
Gets the height of each tile, in pixels. This function should
not be called before
MapboxImageryProvider#ready
returns true.
Type:
- Number
- Source:
(readonly) tileWidth :Number
Gets the width of each tile, in pixels. This function should
not be called before
MapboxImageryProvider#ready
returns true.
Type:
- Number
- Source:
(readonly) tilingScheme :TilingScheme
Gets the tiling scheme used by the provider. This function should
not be called before
MapboxImageryProvider#ready
returns true.
Type:
- Source:
(readonly) url :String
Gets the URL of the Mapbox server.
Type:
- String
- Source:
Methods
getTileCredits(x, y, level) → {Array.<Credit>}
Gets the credits to be displayed when a given tile is displayed.
Parameters:
Name | Type | Description |
---|---|---|
x |
Number | The tile X coordinate. |
y |
Number | The tile Y coordinate. |
level |
Number | The tile level; |
- Source:
Throws:
-
getTileCredits
must not be called before the imagery provider is ready. - Type
- DeveloperError
Returns:
The credits to be displayed when the tile is displayed.
- Type
- Array.<Credit>
pickFeatures(x, y, level, longitude, latitude) → {Promise.<Array.<ImageryLayerFeatureInfo>>|undefined}
Asynchronously determines what features, if any, are located at a given longitude and latitude within
a tile. This function should not be called before
MapboxImageryProvider#ready
returns true.
This function is optional, so it may not exist on all ImageryProviders.
Parameters:
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. |
- Source:
Throws:
-
pickFeatures
must not be called before the imagery provider is ready. - Type
- DeveloperError
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.
- Type
- Promise.<Array.<ImageryLayerFeatureInfo>> | undefined
requestImage(x, y, level) → {Promise.<(Image|Canvas)>|undefined}
Requests the image for a given tile. This function should
not be called before
MapboxImageryProvider#ready
returns true.
Parameters:
Name | Type | Description |
---|---|---|
x |
Number | The tile X coordinate. |
y |
Number | The tile Y coordinate. |
level |
Number | The tile level. |
- Source:
Throws:
-
requestImage
must not be called before the imagery provider is ready. - Type
- DeveloperError
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.
- Type
- Promise.<(Image|Canvas)> | undefined