# BingMapsImageryProvider

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

Provides tiled imagery using the Bing Maps Imagery REST API.

Name | Type | Description
--- | --- | ---
`options` | BingMapsImageryProvider.ConstructorOptions | Object describing initialization options

##### 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
- OpenStreetMapImageryProvider
- SingleTileImageryProvider
- TileMapServiceImageryProvider
- WebMapServiceImageryProvider
- WebMapTileServiceImageryProvider
- UrlTemplateImageryProvider
- Bing Maps REST Services
- Cross-Origin Resource Sharing

### Members

#### static Cesium.BingMapsImageryProvider.logoUrl : String
Scene/BingMapsImageryProvider.js 706

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

#### readonly credit : Credit
Scene/BingMapsImageryProvider.js 531

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.

#### readonly culture : String
Scene/BingMapsImageryProvider.js 345

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.

#### defaultAlpha : Number|undefined
Scene/BingMapsImageryProvider.js 88

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

Default Value: `undefined`

#### defaultBrightness : Number|undefined
Scene/BingMapsImageryProvider.js 115

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`

#### defaultContrast : Number|undefined
Scene/BingMapsImageryProvider.js 124

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`

#### defaultDayAlpha : Number|undefined
Scene/BingMapsImageryProvider.js 106

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`

#### defaultGamma : Number|undefined
Scene/BingMapsImageryProvider.js 149

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

Default Value: `1.0`

#### defaultHue : Number|undefined
Scene/BingMapsImageryProvider.js 132

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

Default Value: `undefined`

#### defaultMagnificationFilter : TextureMagnificationFilter
Scene/BingMapsImageryProvider.js 165

The default texture magnification filter to apply to this provider.

Default Value: `undefined`

#### defaultMinificationFilter : TextureMinificationFilter
Scene/BingMapsImageryProvider.js 157

The default texture minification filter to apply to this provider.

Default Value: `undefined`

#### defaultNightAlpha : Number|undefined
Scene/BingMapsImageryProvider.js 97

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`

#### defaultSaturation : Number|undefined
Scene/BingMapsImageryProvider.js 141

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
Scene/BingMapsImageryProvider.js 494

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
Scene/BingMapsImageryProvider.js 547

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
Scene/BingMapsImageryProvider.js 319

Gets the Bing Maps key.

#### readonly mapStyle : BingMapsStyle
Scene/BingMapsImageryProvider.js 331

Gets the type of Bing Maps imagery to load.

#### readonly maximumLevel : Number|undefined
Scene/BingMapsImageryProvider.js 396

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

#### readonly minimumLevel : Number
Scene/BingMapsImageryProvider.js 415

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

#### readonly proxy : Proxy
Scene/BingMapsImageryProvider.js 307

Gets the proxy used by this provider.

#### readonly ready : Boolean
Scene/BingMapsImageryProvider.js 506

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

#### readonly readyPromise : Promise.<Boolean>
Scene/BingMapsImageryProvider.js 518

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

#### readonly rectangle : Rectangle
Scene/BingMapsImageryProvider.js 453

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
Scene/BingMapsImageryProvider.js 474

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.

#### readonly tileHeight : Number
Scene/BingMapsImageryProvider.js 377

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

#### readonly tileWidth : Number
Scene/BingMapsImageryProvider.js 358

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

#### readonly tilingScheme : TilingScheme
Scene/BingMapsImageryProvider.js 434

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

#### readonly url : String
Scene/BingMapsImageryProvider.js 295

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

### Methods

#### static Cesium.BingMapsImageryProvider.quadKeyToTileXY(quadkey)
Scene/BingMapsImageryProvider.js 675

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

#### static Cesium.BingMapsImageryProvider.tileXYToQuadKey(x, y, level)
Scene/BingMapsImageryProvider.js 647

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 566

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 632

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.<(HTMLImageElement|HTMLCanvasElement)>|undefined
Scene/BingMapsImageryProvider.js 594

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.

### Type Definitions

#### Cesium.BingMapsImageryProvider.ConstructorOptions
Scene/BingMapsImageryProvider.js 19

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.