Module: 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.<module:ol/source/BingMaps~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	Argument	Description
coverageAreas	Array.<module:ol/source/BingMaps~CoverageArea>		The coverage areas
attribution	string	<optional>	The attribution

Options{Object}

Properties:

Name	Type	Argument	Default	Description
cacheSize	number	<optional>		Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
hidpi	boolean	<optional>	false	If true hidpi tiles will be requested.
culture	string	<optional>	'en-us'	Culture code.
key	string			Bing Maps API key. Get yours at https://www.bingmapsportal.com/.
imagerySet	string			Type of imagery.
imageSmoothing	boolean	<optional>	true	Enable image smoothing.
maxZoom	number	<optional>	21	Max zoom. Default is what's advertized by the BingMaps service.
reprojectionErrorThreshold	number	<optional>	0.5	Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
tileLoadFunction	module:ol/Tile~LoadFunction	<optional>		Optional function to load a tile given a URL. The default is function(imageTile, src) { imageTile.getImage().src = src; };
wrapX	boolean	<optional>	true	Whether to wrap the world horizontally.
transition	number	<optional>		Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
zDirection	number | module:ol/array~NearestDirectionFunction	<optional>	0	Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See module:ol/tilegrid/TileGrid~TileGrid#getZForResolution.

Resource{Object}

Properties:

Name	Type	Argument	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.<module:ol/source/BingMaps~ImageryProvider>	<optional>	The array of ImageryProviders

ResourceSet{Object}

Properties:

Name	Type	Description
resources	Array.<module:ol/source/BingMaps~Resource>	Resources.