Provides tiled imagery using the Bing Maps Imagery REST API.
Name | Type | Description |
---|---|---|
options |
BingMapsImageryProvider.ConstructorOptions | Object describing initialization options |
Example:
const bing = new Cesium.BingMapsImageryProvider({
url : 'https://dev.virtualearth.net',
key : 'get-yours-at-https://www.bingmapsportal.com/',
mapStyle : Cesium.BingMapsStyle.AERIAL
});
See:
Members
Gets or sets the URL to the Bing logo for display in the credit.
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
BingMapsImageryProvider#ready
returns true.
The culture to use when requesting Bing Maps imagery. Not
all cultures are supported. See http://msdn.microsoft.com/en-us/library/hh441729.aspx
for information on the supported cultures.
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:
1.0
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. Setting this property to false reduces memory usage
and texture upload time.
Gets the Bing Maps key.
readonly mapStyle : BingMapsStyle
Gets the type of Bing Maps imagery to load.
Gets the maximum level-of-detail that can be requested. This function should
not be called before
BingMapsImageryProvider#ready
returns true.
Gets the minimum level-of-detail that can be requested. This function should
not be called before
BingMapsImageryProvider#ready
returns true.
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 this instance. This function should
not be called before
BingMapsImageryProvider#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
BingMapsImageryProvider#ready
returns true.
Gets the height of each tile, in pixels. This function should
not be called before
BingMapsImageryProvider#ready
returns true.
Gets the width of each tile, in pixels. This function should
not be called before
BingMapsImageryProvider#ready
returns true.
readonly tilingScheme : TilingScheme
Gets the tiling scheme used by this provider. This function should
not be called before
BingMapsImageryProvider#ready
returns true.
Gets the name of the BingMaps server url hosting the imagery.
Methods
Converts a tile's quadkey used to request an image from a Bing Maps server into the
(x, y, level) position.
Name | Type | Description |
---|---|---|
quadkey |
String | The tile's quad key |
- Bing Maps Tile System
- BingMapsImageryProvider#tileXYToQuadKey
See:
Converts a tiles (x, y, level) position into a quadkey used to request an image
from a Bing Maps server.
Name | Type | Description |
---|---|---|
x |
Number | The tile's x coordinate. |
y |
Number | The tile's y coordinate. |
level |
Number | The tile's zoom level. |
- Bing Maps Tile System
- BingMapsImageryProvider#quadKeyToTileXY
See:
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 :
getTileCredits
must not be called before the imagery provider is ready.
Picking features is not currently supported by this imagery provider, so this function simply returns
undefined.
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:
Undefined since picking is not supported.
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
Requests the image for a given tile. This function should
not be called before
BingMapsImageryProvider#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 :
requestImage
must not be called before the imagery provider is ready.
Type Definitions
Initialization options for the BingMapsImageryProvider constructor
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
url |
Resource | String | The url of the Bing Maps server hosting the imagery. | ||
key |
String | The Bing Maps key for your application, which can be created at https://www.bingmapsportal.com/. | ||
tileProtocol |
String |
<optional> |
The protocol to use when loading tiles, e.g. 'http' or 'https'. By default, tiles are loaded using the same protocol as the page. | |
mapStyle |
BingMapsStyle |
<optional> |
BingMapsStyle.AERIAL | The type of Bing Maps imagery to load. |
culture |
String |
<optional> |
'' | The culture to use when requesting Bing Maps imagery. Not all cultures are supported. See http://msdn.microsoft.com/en-us/library/hh441729.aspx for information on the supported cultures. |
ellipsoid |
Ellipsoid |
<optional> |
The ellipsoid. If not specified, the WGS84 ellipsoid is used. | |
tileDiscardPolicy |
TileDiscardPolicy |
<optional> |
The policy that determines if a tile
is invalid and should be discarded. By default, a DiscardEmptyTileImagePolicy
will be used, with the expectation that the Bing Maps server will send a zero-length response for missing tiles.
To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter. |