top
all js glsl

BingMapsImageryProvider

BingMapsImageryProvider

new

Provides tiled imagery using the Bing Maps Imagery REST API.

Parameters:
Name Type Argument Default Description
description.url String The url of the Bing Maps server hosting the imagery.
description.key String <optional>
 An optional Bing Maps key, which can be created at https://www.bingmapsportal.com/.
description.mapStyle Enumeration <optional>
 BingMapsStyle.AERIAL The type of Bing Maps imagery to load.
description.tileDiscardPolicy TileDiscardPolicy <optional>
 The policy that determines if a tile is invalid and should be discarded. If this value is not specified, a default DiscardMissingTileImagePolicy is used which requests tile 0,0 at the maximum tile level and checks pixels (0,0), (120,140), (130,160), (200,50), and (200,200). If all of these pixels are transparent, the discard check is disabled and no tiles are discarded. If any of them have a non-transparent color, any tile that has the same values in these pixel locations is discarded. The end result of these defaults should be correct tile discarding for a standard Bing Maps server. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.
description.proxy Proxy <optional>
 A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
Throws:
DeveloperError : description.url is required.
Example
var bing = new BingMapsImageryProvider({
    url : 'http://dev.virtualearth.net',
    mapStyle : BingMapsStyle.AERIAL
});
See:
Source:

Members

:Number

The default ImageryLayer#gamma to use for imagery layers created for this provider. By default, this is set to 1.3 for the "aerial" and "aerial with labels" map styles and 1.0 for all others. Changing this value after creating an ImageryLayer for this provider will have no effect. Instead, set the layer's ImageryLayer#gamma property.
Default Value:
  • 1.0

Methods

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#isReady returns true.

Returns:
Credit The credit, or undefined if no credit exists

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.

Returns:
Event The event.

Gets the extent, in radians, of the imagery provided by this instance. This function should not be called before BingMapsImageryProvider#isReady returns true.

Throws:
DeveloperError : getExtent must not be called before the imagery provider is ready.
Returns:
Extent The extent.

Gets the Bing Maps key.

Returns:
String The key.

Gets the type of Bing Maps imagery to load.

Returns:
BingMapsStyle The style.

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

Throws:
DeveloperError : getMaximumLevel must not be called before the imagery provider is ready.
Returns:
Number The maximum level.

Gets the minimum level-of-detail that can be requested. This function should not be called before BingMapsImageryProvider#isReady returns true.

Throws:
DeveloperError : getMinimumLevel must not be called before the imagery provider is ready.
Returns:
Number The minimum level.

Gets the proxy used by this provider.

Returns:
Proxy The proxy.
See:

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#isReady returns true.

Throws:
DeveloperError : getTileDiscardPolicy must not be called before the imagery provider is ready.
Returns:
TileDiscardPolicy The discard policy.
See:

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

Throws:
DeveloperError : getTileHeight must not be called before the imagery provider is ready.
Returns:
Number The height.

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

Throws:
DeveloperError : getTileWidth must not be called before the imagery provider is ready.
Returns:
Number The width.

Gets the tiling scheme used by this provider. This function should not be called before BingMapsImageryProvider#isReady returns true.

Throws:
DeveloperError : getTilingScheme must not be called before the imagery provider is ready.
Returns:
TilingScheme The tiling scheme.
See:

Gets the name of the Bing Maps server url hosting the imagery.

Returns:
String The url.

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

Returns:
Boolean True if the provider is ready to use; otherwise, false.

Requests the image for a given tile. This function should not be called before BingMapsImageryProvider#isReady returns true.

Parameters:
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
Throws:
DeveloperError : getTileDiscardPolicy must not be called before the imagery provider is ready.
Returns:
Promise 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.

<static>

Converts a tile's quadkey used to request an image from a Bing Maps server into the (x, y, level) position.

Parameters:
Name Type Description
quadkey String The tile's quad key
See:

<static>

Converts a tiles (x, y, level) position into a quadkey used to request an image from a Bing Maps server.

Parameters:
Name Type Description
x Number The tile's x coordinate.
y Number The tile's y coordinate.
level Number The tile's zoom level.
See: