麻辣GIS微信平台

更多 GIS 干货

微信关注不错过

Cesium API - WebMapServiceImageryProvider 中文文档

本文介绍下Cesium中 WebMapServiceImageryProvider API的详细使用说明。

WebMapServiceImageryProvider API 调用方法

new Cesium.WebMapServiceImageryProvider(options)
提供由Web地图服务(WMS)服务器托管的瓦片图像。
Name Type Description
options Object 此对象拥有以下属性:
Name Type Default Description
url Resource | String WMS服务的URL。该URL支持与UrlTemplateImageryProvider相同的关键字。
layers String 要包括的图层,以逗号分隔。
parameters Object WebMapServiceImageryProvider.DefaultParameters optional 在GetMap URL中传递给WMS服务器的其他参数。
getFeatureInfoParameters Object WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters optional 在GetFeatureInfo URL中传递给WMS服务器的其他参数。
enablePickFeatures Boolean true optional 是否启用拾取要素。 如果为true,WebMapServiceImageryProvider#pickFeatures将调用WMS服务器上的GetFeatureInfo操作,并返回响应中包含的要素。 如果是false, WebMapServiceImageryProvider#pickFeatures将立即返回undefined(表示没有可拾取的要素),而不需要与服务器通信。 如果您知道您的WMS服务器不支持GetFeatureInfo,或者您不希望该提供者的要素可拾取,则将此属性设置为false。
getFeatureInfoFormats Array.<GetFeatureInfoFormat> WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats optional 尝试WMS GetFeatureInfo请求的格式。
rectangle Rectangle Rectangle.MAX_VALUE optional 地图的矩形范围。
tilingScheme TilingScheme new GeographicTilingScheme() optional 切片方案。
ellipsoid Ellipsoid optional 椭球。 如果指定了tilingScheme,则将忽略此参数,而是使用切片方案的椭球体。 如果未指定任何参数,则使用WGS84椭球。
tileWidth Number 256 optional 瓦片宽。
tileHeight Number 256 optional 瓦片高。
minimumLevel Number 0 optional 图像提供器支持的最小级别。 指定此值时,请注意最小级别的图块数量较小,例如四个或更少。 数量较大可能会导致渲染问题。
maximumLevel Number optional 图像提供程序支持的最大级别,如果没有限制,则为未定义。
crs String optional CRS规范,用于WMS规范> = 1.3.0。
srs String optional SRS规范,用于WMS规范1.1.0或1.1.1。
credit Credit | String optional 数据源的版权,它显示在画布上。
subdomains String | Array.<String> 'abc' optional URL模板中用于 {s} 占位符的子域。 如果此参数是单个字符串,则字符串中的每个字符都是一个子域。 如果是数组,则数组中的每个元素都是一个子域。
clock Clock optional 确定时间维度的值时使用的Clock实例。 当指定options.times时是必需的。
times TimeIntervalCollection optional TimeIntervalCollection,其数据属性是一个包含时间动态维度及其值的对象。
示例:
var provider = new Cesium.WebMapServiceImageryProvider({
    url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
    layers : '0',
    proxy: new Cesium.DefaultProxy('/proxy/')
});
viewer.imageryLayers.addImageryProvider(provider);
参考:

成员变量

staticconstantCesium.WebMapServiceImageryProvider.DefaultParameters : Object
要包含在WMS URL中的默认参数以获取图像。取值如下: service=WMS version=1.1.1 request=GetMap styles= format=image/jpeg
staticconstantCesium.WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters : Object
WMS URL中包含的默认参数以获取要素信息。取值如下: service=WMS version=1.1.1 request=GetFeatureInfo
获取或设置用于获取用于时间动态参数的时间的时钟实例。
获取版权信息。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
enablePickFeatures : Boolean
如果为true,WebMapServiceImageryProvider#pickFeatures将调用WMS服务器上的GetFeatureInfo操作,并返回响应中包含的要素。 如果是false, WebMapServiceImageryProvider#pickFeatures将立即返回undefined(表示没有可拾取的要素),而不需要与服务器通信。 如果您知道您的WMS服务器不支持GetFeatureInfo,或者您不希望该提供者的要素可拾取,则将此属性设置为false。
Default Value: true
获取此提供器遇到异步错误时触发的事件。 通过订阅事件,您将收到错误通知,并可能从中恢复。事件监听器传递一个TileProviderError的实例。
readonlyhasAlphaChannel : Boolean
获取影像是否有Alpha通道。
要包括的图层,以逗号分隔。
readonlymaximumLevel : Number
获取可以请求的最大级别。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
readonlyminimumLevel : Number
获取可以请求的最小级别。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
获取此提供器使用的代理。
获取一个值,该值指示提供器是否已准备好使用。
readonlyreadyPromise : Promise.<Boolean>
获取一个在提供器准备好使用时解析为true的Promise。
地图矩形范围。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
获取瓦片忽略策略。如果未定义,则忽略策略负责通过其shouldDiscardImage函数过滤掉“丢失”的瓦片。 如果此函数返回未定义,则不过滤任何切片。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
readonlytileHeight : Number
获取瓦片高,以像素为单位。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
readonlytileWidth : Number
获取瓦片宽,以像素为单位。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
获取切片方案。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
获取或设置用于获取时间动态参数的时间间隔集合。每个的数据 TimeInterval是一个对象,它包含在瓦片请求期间使用的属性的键和值。
获取WMS服务器的URL。

内置方法

getTileCredits(x, y, level)Array.<Credit>
获取当请求的瓦片被显示出来时,要显示的版权信息。
Name Type Description
x Number 瓦片的X坐标。
y Number 瓦片的Y坐标。
level Number 瓦片的层级。
返回值:
返回的版权信息。
异常情况:
  • DeveloperError : 在图像提供器准备就绪之前,不得调用 getTileCredits
pickFeatures(x, y, level, longitude, latitude)Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
异步地确定哪些要素(如果有的话)位于瓦片中给定的经度和纬度。 在ImageryProvider#ready返回true之前,不应该调用此函数。 这个函数是可选的,所以它可能不存在于所有的ImageryProviders上。
Name Type Description
x Number 瓦片的X坐标。
y Number 瓦片的Y坐标。
level Number 瓦片的级别。
longitude Number 拾取要素的经度。
latitude Number 拾取要素的纬度。
返回值:
对所选要素的promise,它将在异步拾取完成时解析。 解析后的值是ImageryLayerFeatureInfo实例的数组。如果在给定位置没有发现任何要素,则该数组可能为空。 如果不支持拾取,它也可能是未定义的。
异常情况:
  • DeveloperError : pickFeatures在图像提供器准备好之前不能被调用。
requestImage(x, y, level, request)Promise.<(Image|Canvas)>|undefined
请求给定块的瓦片。在WebMapServiceImageryProvider#ready返回true之前,不应该调用此函数。
Name Type Description
x Number 瓦片的X坐标。
y Number 瓦片的Y坐标。
level Number 瓦片的层级。
request Request optional Request对象(仅供内部使用)。
返回值:
返回值有以下3种情况: 1.当图像可用时,返回对图像的Promise。 2.如果有太多对服务器的活动请求,则返回未定义图像,并且应该稍后重新请求。 3.解析后的图像可以是图像,也可以是画布DOM对象。
异常情况:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.

其他API

Cesium中文API文档手册(v1.63.1版本)参考:《Cesium中文API文档手册(v1.63.1版本)

相关阅读

麻辣GIS-Sailor

作者:

GIS爱好者,学GIS,更爱玩GIS。

声明

1.本文所分享的所有需要用户下载使用的内容(包括但不限于软件、数据、图片)来自于网络或者麻辣GIS粉丝自行分享,版权归该下载资源的合法拥有者所有,如有侵权请第一时间联系本站删除。

2.下载内容仅限个人学习使用,请切勿用作商用等其他用途,否则后果自负。

手机阅读
公众号关注
知识星球
手机阅读
麻辣GIS微信公众号关注
最新GIS干货
关注麻辣GIS知识星球
私享圈子

留言板(小编看到第一时间回复)