# Module: ol/source/BingMaps

This documentation is for OpenLayers v10.9.0. The latest is v.

## ol/source/BingMaps

### Classes

BingMaps

### Type Definitions

#### BingMapsImageryMetadataResponse{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `statusCode` | number | The response status code
  `statusDescription` | string | The response status description
  `authenticationResultCode` | string | The authentication result code
  `resourceSets` | Array<ResourceSet> | The array of resource sets

#### CoverageArea{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `zoomMin` | number | The minimum zoom
  `zoomMax` | number | The maximum zoom
  `bbox` | Array.<number> | The coverage bounding box

#### ImageryProvider{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `coverageAreas` | Array<CoverageArea> | The coverage areas
  `attribution` | string | undefined | The attribution

#### Options{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `cacheSize` | number | undefined | Deprecated. Use the cacheSize option on the layer instead.
  `hidpi` | boolean (defaults to false) | If `true` hidpi tiles will be requested.
  `culture` | string (defaults to 'en-us') | Culture code.
  `key` | string | Bing Maps API key. Get yours at https://www.bingmapsportal.com/.
  `imagerySet` | string | Type of imagery.
  `interpolate` | boolean (defaults to true) | Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
  `maxZoom` | number (defaults to 21) | Max zoom. Default is what's advertized by the BingMaps service.
  `reprojectionErrorThreshold` | number (defaults to 0.5) | Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
  `tileLoadFunction` | LoadFunction | undefined | Optional function to load a tile given a URL. The default is
      function(imageTile, src) {
        imageTile.getImage().src = src;
      };
  `wrapX` | boolean (defaults to true) | Whether to wrap the world horizontally.
  `transition` | number | undefined | Duration of the opacity transition for rendering. To disable the opacity transition, pass `transition: 0`.
  `zDirection` | number | NearestDirectionFunction (defaults to 0) | Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See `getZForResolution`.
  `placeholderTiles` | boolean | undefined | Whether to show BingMaps placeholder tiles when zoomed past the maximum level provided in an area. When `false`, requests beyond the maximum zoom level will return no tile. When `true`, the placeholder tile will be returned. When not set, the default behaviour of the imagery set takes place, which is unique for each imagery set in BingMaps.
  `url` | string (defaults to 'https://dev.virtualearth.net/REST/v1/Imagery/Metadata/') | The Bing Map Metadata API URL.

#### Resource{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `imageHeight` | number | The image height
  `imageWidth` | number | The image width
  `zoomMin` | number | The minimum zoom level
  `zoomMax` | number | The maximum zoom level
  `imageUrl` | string | The image URL
  `imageUrlSubdomains` | Array.<string> | The image URL subdomains for rotation
  `imageryProviders` | Array<ImageryProvider> | undefined | The array of ImageryProviders

#### ResourceSet{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `resources` | Array<Resource> | Resources.