Provides tiled imagery hosted by Mapbox.
| Name | Type | Description |
|---|---|---|
options |
MapboxStyleImageryProvider.ConstructorOptions | Object describing initialization options |
Example:
// Mapbox style provider
const mapbox = new Cesium.MapboxStyleImageryProvider({
styleId: 'streets-v11',
accessToken: 'thisIsMyAccessToken'
});See:
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
MapboxStyleImageryProvider#ready returns true.
The default alpha blending value of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
-
Default Value:
undefined
The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0
makes the imagery darker while greater than 1.0 makes it brighter.
-
Default Value:
undefined
The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
the contrast while greater than 1.0 increases it.
-
Default Value:
undefined
The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
-
Default Value:
undefined
The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
-
Default Value:
undefined
The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
-
Default Value:
undefined
defaultMagnificationFilter : TextureMagnificationFilter
The default texture magnification filter to apply to this provider.
-
Default Value:
undefined
defaultMinificationFilter : TextureMinificationFilter
The default texture minification filter to apply to this provider.
-
Default Value:
undefined
The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
-
Default Value:
undefined
The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
saturation while greater than 1.0 increases it.
-
Default Value:
undefined
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.
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.
Gets the maximum level-of-detail that can be requested. This function should
not be called before
MapboxStyleImageryProvider#ready returns true.
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.
readonly proxy : Proxy
Gets the proxy used by this provider.
Gets a value indicating whether or not the provider is ready for use.
Gets a promise that resolves to true when the provider is ready for use.
readonly rectangle : Rectangle
Gets the rectangle, in radians, of the imagery provided by the instance. This function should
not be called before
MapboxStyleImageryProvider#ready returns true.
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
MapboxStyleImageryProvider#ready returns true.
Gets the height of each tile, in pixels. This function should
not be called before
MapboxStyleImageryProvider#ready returns true.
Gets the width of each tile, in pixels. This function should
not be called before
MapboxStyleImageryProvider#ready returns true.
readonly tilingScheme : TilingScheme
Gets the tiling scheme used by the provider. This function should
not be called before
MapboxStyleImageryProvider#ready returns true.
Gets the URL of the Mapbox server.
Methods
getTileCredits(x, y, level) → Array.<Credit>
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 :
getTileCreditsmust not be called before the imagery provider is ready.
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
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 :
pickFeaturesmust not be called before the imagery provider is ready.
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
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.
Throws:
-
DeveloperError :
requestImagemust not be called before the imagery provider is ready.
Type Definitions
Initialization options for the MapboxStyleImageryProvider constructor
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
url |
Resource | String |
<optional> |
'https://api.mapbox.com/styles/v1/' | The Mapbox server url. |
username |
String |
<optional> |
'mapbox' | The username of the map account. |
styleId |
String | The Mapbox Style ID. | ||
accessToken |
String | The public access token for the imagery. | ||
tilesize |
Number |
<optional> |
512 | 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 |
<optional> |
0 | 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 |
<optional> |
Rectangle.MAX_VALUE | The rectangle, in radians, covered by the image. |
credit |
Credit | String |
<optional> |
A credit for the data source, which is displayed on the canvas. |