BingMapsImageryProvider

new Cesium.BingMapsImageryProvider(options)
engine/Source/Scene/BingMapsImageryProvider.js 201

To construct a BingMapsImageryProvider, call BingMapsImageryProvider.fromUrl. Do not call the constructor directly.
Provides tiled imagery using the Bing Maps Imagery REST API.
Name Type Description
options BingMapsImageryProvider.ConstructorOptions Object describing initialization options
Example:
const bing = await Cesium.BingMapsImageryProvider.fromUrl(
  "https://dev.virtualearth.net", {
    key: "get-yours-at-https://www.bingmapsportal.com/",
    mapStyle: Cesium.BingMapsStyle.AERIAL
});
See:

Members

static Cesium.BingMapsImageryProvider.logoUrl : string
engine/Source/Scene/BingMapsImageryProvider.js 974

Gets or sets the URL to the Bing logo for display in the credit.

readonly credit : Credit
engine/Source/Scene/BingMapsImageryProvider.js 500

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

readonly culture : string
engine/Source/Scene/BingMapsImageryProvider.js 353

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.

deprecated defaultAlpha : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 529

The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.

Deprecated: true

deprecated defaultBrightness : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 601

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.

Deprecated: true

deprecated defaultContrast : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 625

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.

Deprecated: true

deprecated defaultDayAlpha : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 577

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.

Deprecated: true

deprecated defaultGamma : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 695

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.

Deprecated: true

deprecated defaultHue : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 648

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.

Deprecated: true

deprecated defaultMagnificationFilter : TextureMagnificationFilter
engine/Source/Scene/BingMapsImageryProvider.js 741

The default texture magnification filter to apply to this provider.

Deprecated: true

deprecated defaultMinificationFilter : TextureMinificationFilter
engine/Source/Scene/BingMapsImageryProvider.js 718

The default texture minification filter to apply to this provider.

Deprecated: true

deprecated defaultNightAlpha : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 553

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.

Deprecated: true

deprecated defaultSaturation : Number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 672

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.

Deprecated: true

readonly errorEvent : Event
engine/Source/Scene/BingMapsImageryProvider.js 453

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.

readonly hasAlphaChannel : boolean
engine/Source/Scene/BingMapsImageryProvider.js 516

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.

readonly key : string
engine/Source/Scene/BingMapsImageryProvider.js 327

Gets the Bing Maps key.

readonly mapStyle : BingMapsStyle
engine/Source/Scene/BingMapsImageryProvider.js 339

Gets the type of Bing Maps imagery to load.

readonly maximumLevel : number|undefined
engine/Source/Scene/BingMapsImageryProvider.js 389

Gets the maximum level-of-detail that can be requested.

readonly minimumLevel : number
engine/Source/Scene/BingMapsImageryProvider.js 401

Gets the minimum level-of-detail that can be requested.

readonly proxy : Proxy
engine/Source/Scene/BingMapsImageryProvider.js 315

Gets the proxy used by this provider.

readonly deprecated ready : boolean
engine/Source/Scene/BingMapsImageryProvider.js 466

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

Deprecated: true

readonly deprecated readyPromise : Promise.<boolean>
engine/Source/Scene/BingMapsImageryProvider.js 483

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

Deprecated: true

readonly rectangle : Rectangle
engine/Source/Scene/BingMapsImageryProvider.js 425

Gets the rectangle, in radians, of the imagery provided by this instance.

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/BingMapsImageryProvider.js 439

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.

readonly tileHeight : number
engine/Source/Scene/BingMapsImageryProvider.js 377

Gets the height of each tile, in pixels.

readonly tileWidth : number
engine/Source/Scene/BingMapsImageryProvider.js 365

Gets the width of each tile, in pixels.

readonly tilingScheme : TilingScheme
engine/Source/Scene/BingMapsImageryProvider.js 413

Gets the tiling scheme used by this provider.

readonly url : string
engine/Source/Scene/BingMapsImageryProvider.js 303

Gets the name of the BingMaps server url hosting the imagery.

Methods

static Cesium.BingMapsImageryProvider.fromUrl(url, options) → Promise.<BingMapsImageryProvider>
engine/Source/Scene/BingMapsImageryProvider.js 775

Creates an ImageryProvider which provides tiled imagery using the Bing Maps Imagery REST API.
Name Type Description
url Resource | String The url of the Bing Maps server hosting the imagery.
options BingMapsImageryProvider.ConstructorOptions Object describing initialization options
Returns:
A promise that resolves to the created BingMapsImageryProvider
Throws:
  • RuntimeError : metadata does not specify one resource in resourceSets
Example:
const bing = await Cesium.BingMapsImageryProvider.fromUrl(
  "https://dev.virtualearth.net", {
    key: "get-yours-at-https://www.bingmapsportal.com/",
    mapStyle: Cesium.BingMapsStyle.AERIAL
});

static Cesium.BingMapsImageryProvider.quadKeyToTileXY(quadkey)
engine/Source/Scene/BingMapsImageryProvider.js 943

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
See:

static Cesium.BingMapsImageryProvider.tileXYToQuadKey(x, y, level)
engine/Source/Scene/BingMapsImageryProvider.js 915

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.
See:

getTileCredits(x, y, level) → Array.<Credit>
engine/Source/Scene/BingMapsImageryProvider.js 831

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.

pickFeatures(x, y, level, longitude, latitude) → undefined
engine/Source/Scene/BingMapsImageryProvider.js 894

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
engine/Source/Scene/BingMapsImageryProvider.js 857

Requests the image for a given tile.
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.

Type Definitions

Cesium.BingMapsImageryProvider.ConstructorOptions
engine/Source/Scene/BingMapsImageryProvider.js 18

Initialization options for the BingMapsImageryProvider constructor
Properties:
Name Type Attributes Default Description
url Resource | string <optional>
 The url of the Bing Maps server hosting the imagery. Deprecated.
key string <optional>
 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.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets