Cesium API - BingMapsImageryProvider 中文文档

new Cesium.BingMapsImageryProvider(options)

使用Bing Maps图像REST API提供瓦片图像。

Name Type Description

options

Object

此对象拥有以下属性：

Name	Type	Default	Description
`url`	Resource \| String		托管图像的Bing Maps服务器的url。
`key`	String		optional Bing Maps key，可以在https://www.bingmapsportal.com/上创建。如果未提供此参数，则使用`BingMapsApi.defaultKey`，默认情况下undefined 。
`tileProtocol`	String		optional 加载瓦片时使用的协议，例如 “ http”或“ https”。默认情况下，使用与页面相同的协议加载瓦片。
`mapStyle`	BingMapsStyle	`BingMapsStyle.AERIAL`	optional Bing Maps要加载的图像类型。
`culture`	String	`''`	optional 请求必应地图图像时要使用的区域性。并非所有区域都受支持。有关受支持的区域性的信息，请参见http://msdn.microsoft.com/zh-cn/library/hh441729.aspx。
`ellipsoid`	Ellipsoid		optional 椭球。如果没有指定，默认为WGS椭球。
`tileDiscardPolicy`	TileDiscardPolicy		optional 确定某个瓦片是否无效并应被丢弃的策略。默认情况下，将使用`DiscardEmptyTileImagePolicy`，期望Bing Maps服务器将为丢失的瓦片发送零长度响应。为确保没有瓦片被丢弃，请为此参数构造并传递一个`NeverTileDiscardPolicy`。

示例：

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

参考：

成员变量

staticCesium.BingMapsImageryProvider.logoUrl : String

Scene/BingMapsImageryProvider.js 603

获取或设置Bing Map的Logo的URL，以在版权中显示。

readonlycredit : Credit

Scene/BingMapsImageryProvider.js 437

获取版权信息。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlyculture : String

Scene/BingMapsImageryProvider.js 258

请求必应地图图像时要使用的区域性。并非所有culture都受支持。有关受支持的区域性的信息，请参见http://msdn.microsoft.com/zh-cn/library/hh441729.aspx。

defaultGamma : Number

Scene/BingMapsImageryProvider.js 90

为该提供器创建的图像图层使用的默认ImageryLayer#gamma。在为这个提供器创建ImageryLayer之后更改这个值将没有任何效果。相反，设置图层的ImageryLayer#gamma属性。

Default Value: 1.0

readonlyerrorEvent : Event

Scene/BingMapsImageryProvider.js 401

获取此提供器遇到异步错误时触发的事件。通过订阅事件，您将收到错误通知，并可能从中恢复。事件监听器传递一个TileProviderError的实例。

readonlyhasAlphaChannel : Boolean

Scene/BingMapsImageryProvider.js 449

获取影像是否有Alpha通道。

readonlykey : String

Scene/BingMapsImageryProvider.js 233

获取 Bing Maps key。

readonlymapStyle : BingMapsStyle

Scene/BingMapsImageryProvider.js 245

获取地图样式。

readonlymaximumLevel : Number

Scene/BingMapsImageryProvider.js 307

获取请求的最大级别。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlyminimumLevel : Number

Scene/BingMapsImageryProvider.js 325

获取请求的最小级别。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlyproxy : Proxy

Scene/BingMapsImageryProvider.js 221

获取此提供器使用的代理。

readonlyready : Boolean

Scene/BingMapsImageryProvider.js 413

获取一个值，该值指示提供器是否已准备好使用。

readonlyreadyPromise : Promise.<Boolean>

Scene/BingMapsImageryProvider.js 425

获取一个在提供器准备就绪时可以解析为true的Promise。

readonlyrectangle : Rectangle

Scene/BingMapsImageryProvider.js 363

获取要显示的地图范围（以弧度表示）。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlytileDiscardPolicy : TileDiscardPolicy

Scene/BingMapsImageryProvider.js 382

获取瓦片忽略策略。如果未定义，则丢弃策略负责通过其shouldDiscardImage函数过滤掉“丢失”的瓦片。如果此函数返回未定义，则不过滤任何切片。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlytileHeight : Number

Scene/BingMapsImageryProvider.js 288

获取瓦片高，以像素为单位。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlytileWidth : Number

Scene/BingMapsImageryProvider.js 270

获取瓦片宽，以像素为单位。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlytilingScheme : TilingScheme

Scene/BingMapsImageryProvider.js 344

获取切片方案。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

readonlyurl : String

Scene/BingMapsImageryProvider.js 209

获取托管图像的BingMaps服务器url的名称。

内置方法

staticCesium.BingMapsImageryProvider.quadKeyToTileXY(quadkey)

Scene/BingMapsImageryProvider.js 572

将用于从Bing Maps服务器请求图像的瓦片的quad key转换为（x，y，level）位置。

Name	Type	Description
`quadkey`	String	quad key

参考：

Bing Maps Tile System
BingMapsImageryProvider#tileXYToQuadKey

staticCesium.BingMapsImageryProvider.tileXYToQuadKey(x, y, level)

Scene/BingMapsImageryProvider.js 545

将瓦片（x，y，级别）位置转换为用于从Bing Maps服务器请求图像的QuadKey。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的层级。

参考：

Bing Maps Tile System
BingMapsImageryProvider#quadKeyToTileXY

getTileCredits(x, y, level) → Array.<Credit>

Scene/BingMapsImageryProvider.js 468

获取当请求的瓦片被显示出来时，要显示的版权信息。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的层级。

返回值：

返回的版权。

异常情况：

DeveloperError : 在图像提供器准备就绪之前，不得调用 getTileCredits 。

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

Scene/BingMapsImageryProvider.js 531

这个图像提供器目前不支持拾取功能，所以这个函数只是返回未定义。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的级别。
`longitude`	Number	拾取要素的经度。
`latitude`	Number	拾取要素的纬度。

返回值：

对所选要素的promise，它将在异步拾取完成时解析。解析后的值是ImageryLayerFeatureInfo实例的数组。如果在给定位置没有发现任何要素，则该数组可能为空。如果不支持拾取，它也可能是未定义的。

requestImage(x, y, level, request) → Promise.<(Image|Canvas)>|undefined

Scene/BingMapsImageryProvider.js 495

请求给定块的瓦片。在 BingMapsImageryProvider#ready 返回true之前，不应调用此函数。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的层级。
`request`	Request	optional Request对象（仅供内部使用）。