BingMapsImageryProvider - Cesium Documentation

# BingMapsImageryProvider

#### new BingMapsImageryProvider(options)

  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` | 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. If `BingMapsApi.defaultKey` is undefined as well, a message is written to the console reminding you that you must create and supply a Bing Maps key as soon as possible. Please do not deploy an application that uses Bing Maps imagery without creating a separate key for your application.
  `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` | String | `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. 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.
  `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.

  ##### Example:

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

  ##### See:

  - ArcGisMapServerImageryProvider
  - GoogleEarthImageryProvider
  - OpenStreetMapImageryProvider
  - SingleTileImageryProvider
  - TileMapServiceImageryProvider
  - WebMapServiceImageryProvider
  - WebMapTileServiceImageryProvider
  - UrlTemplateImageryProvider
  - Bing Maps REST Services
  - Cross-Origin Resource Sharing
  Source: Scene/BingMapsImageryProvider.js, line 95

### Members

#### readonlycredit :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.
  Source: Scene/BingMapsImageryProvider.js, line 451

#### readonlyculture :String

  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.
  Source: Scene/BingMapsImageryProvider.js, line 276

#### defaultGamma :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`
  Source: Scene/BingMapsImageryProvider.js, line 123

#### readonlyerrorEvent :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`.
  Source: Scene/BingMapsImageryProvider.js, line 426

#### readonlyhasAlphaChannel :Boolean

  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.
  Source: Scene/BingMapsImageryProvider.js, line 467

#### readonlykey :String

  Gets the Bing Maps key.
  Source: Scene/BingMapsImageryProvider.js, line 250

#### readonlymapStyle :BingMapsStyle

  Gets the type of Bing Maps imagery to load.
  Source: Scene/BingMapsImageryProvider.js, line 262

#### readonlymaximumLevel :Number

  Gets the maximum level-of-detail that can be requested. This function should not be called before `BingMapsImageryProvider#ready` returns true.
  Source: Scene/BingMapsImageryProvider.js, line 328

#### readonlyminimumLevel :Number

  Gets the minimum level-of-detail that can be requested. This function should not be called before `BingMapsImageryProvider#ready` returns true.
  Source: Scene/BingMapsImageryProvider.js, line 347

#### readonlyproxy :Proxy

  Gets the proxy used by this provider.
  Source: Scene/BingMapsImageryProvider.js, line 237

#### readonlyready :Boolean

  Gets a value indicating whether or not the provider is ready for use.
  Source: Scene/BingMapsImageryProvider.js, line 438

#### readonlyrectangle :Rectangle

  Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before `BingMapsImageryProvider#ready` returns true.
  Source: Scene/BingMapsImageryProvider.js, line 385

#### readonlytileDiscardPolicy :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.
  Source: Scene/BingMapsImageryProvider.js, line 406

#### readonlytileHeight :Number

  Gets the height of each tile, in pixels. This function should not be called before `BingMapsImageryProvider#ready` returns true.
  Source: Scene/BingMapsImageryProvider.js, line 308

#### readonlytileWidth :Number

  Gets the width of each tile, in pixels. This function should not be called before `BingMapsImageryProvider#ready` returns true.
  Source: Scene/BingMapsImageryProvider.js, line 289

#### readonlytilingScheme :TilingScheme

  Gets the tiling scheme used by this provider. This function should not be called before `BingMapsImageryProvider#ready` returns true.
  Source: Scene/BingMapsImageryProvider.js, line 366

#### readonlyurl :String

  Gets the name of the BingMaps server url hosting the imagery.
  Source: Scene/BingMapsImageryProvider.js, line 225

### Methods

#### staticBingMapsImageryProvider.quadKeyToTileXY(quadkey)

  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
  Source: Scene/BingMapsImageryProvider.js, line 579

#### staticBingMapsImageryProvider.tileXYToQuadKey(x, y, level)

  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
  Source: Scene/BingMapsImageryProvider.js, line 551

#### 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.
  Source: Scene/BingMapsImageryProvider.js, line 486

#### pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

  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.
  Source: Scene/BingMapsImageryProvider.js, line 534

#### requestImage(x, y, level) → Promise.<(Image|Canvas)>|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.

  ##### 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.
  Source: Scene/BingMapsImageryProvider.js, line 509