# BingMapsImageryProvider

#### new Cesium.BingMapsImageryProvider(options)
Scene/BingMapsImageryProvider.js 86

Provides tiled imagery using the Bing Maps Imagery REST API.

Name | Type | Description
--- | --- | ---

`options`

Object

Object with the following properties:

Name | Type | Default | Description
--- | --- | --- | ---
`url` | Resource | String |  | The url of the Bing Maps server hosting the imagery.
`key` | String |  | optional The Bing Maps key for your application, which can be created at https://www.bingmapsportal.com/. If this parameter is not provided, `BingMapsApi.defaultKey` is used, which is undefined by default.
`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 | `BingMapsStyle.AERIAL` | optional 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.

##### Example:

    var bing = new Cesium.BingMapsImageryProvider({
        url : 'https://dev.virtualearth.net',
        key : 'get-yours-at-https://www.bingmapsportal.com/',
        mapStyle : Cesium.BingMapsStyle.AERIAL
    });

##### See:

- ArcGisMapServerImageryProvider
- GoogleEarthEnterpriseMapsProvider
- createOpenStreetMapImageryProvider
- SingleTileImageryProvider
- createTileMapServiceImageryProvider
- WebMapServiceImageryProvider
- WebMapTileServiceImageryProvider
- UrlTemplateImageryProvider
- Bing Maps REST Services
- Cross-Origin Resource Sharing

### Members

#### staticCesium.BingMapsImageryProvider.logoUrl : String
Scene/BingMapsImageryProvider.js 648

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

#### readonlycredit : Credit
Scene/BingMapsImageryProvider.js 473

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.

#### readonlyculture : String
Scene/BingMapsImageryProvider.js 287

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.

#### defaultGamma : Number
Scene/BingMapsImageryProvider.js 118

The default `ImageryLayer#gamma` to use for imagery layers created for this provider. 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`

#### readonlyerrorEvent : Event
Scene/BingMapsImageryProvider.js 436

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`.

#### readonlyhasAlphaChannel : Boolean
Scene/BingMapsImageryProvider.js 489

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.

#### readonlykey : String
Scene/BingMapsImageryProvider.js 261

Gets the Bing Maps key.

#### readonlymapStyle : BingMapsStyle
Scene/BingMapsImageryProvider.js 273

Gets the type of Bing Maps imagery to load.

#### readonlymaximumLevel : Number
Scene/BingMapsImageryProvider.js 338

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

#### readonlyminimumLevel : Number
Scene/BingMapsImageryProvider.js 357

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

#### readonlyproxy : Proxy
Scene/BingMapsImageryProvider.js 249

Gets the proxy used by this provider.

#### readonlyready : Boolean
Scene/BingMapsImageryProvider.js 448

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

#### readonlyreadyPromise : Promise.<Boolean>
Scene/BingMapsImageryProvider.js 460

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

#### readonlyrectangle : Rectangle
Scene/BingMapsImageryProvider.js 395

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

#### readonlytileDiscardPolicy : TileDiscardPolicy
Scene/BingMapsImageryProvider.js 416

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.

#### readonlytileHeight : Number
Scene/BingMapsImageryProvider.js 319

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

#### readonlytileWidth : Number
Scene/BingMapsImageryProvider.js 300

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

#### readonlytilingScheme : TilingScheme
Scene/BingMapsImageryProvider.js 376

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

#### readonlyurl : String
Scene/BingMapsImageryProvider.js 237

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

### Methods

#### staticCesium.BingMapsImageryProvider.quadKeyToTileXY(quadkey)
Scene/BingMapsImageryProvider.js 617

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:

- Bing Maps Tile System
- BingMapsImageryProvider#tileXYToQuadKey

#### staticCesium.BingMapsImageryProvider.tileXYToQuadKey(x, y, level)
Scene/BingMapsImageryProvider.js 589

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:

- Bing Maps Tile System
- BingMapsImageryProvider#quadKeyToTileXY

#### getTileCredits(x, y, level) → Array.<Credit>
Scene/BingMapsImageryProvider.js 508

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.

#### pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Scene/BingMapsImageryProvider.js 574

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:

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.

#### requestImage(x, y, level, request) → Promise.<(Image|Canvas)>|undefined
Scene/BingMapsImageryProvider.js 536

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. The resolved image may be either an Image or a Canvas DOM object.

##### Throws:

- DeveloperError : `requestImage` must not be called before the imagery provider is ready.