提供由 Web 地图服务(WMS)服务器托管的瓦片影像。
| Name | Type | Description |
|---|---|---|
options |
WebMapServiceImageryProvider.ConstructorOptions | 描述初始化选项的对象。 |
Example:
const provider = new Cesium.WebMapServiceImageryProvider({
url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
layers : '0',
proxy: new Cesium.DefaultProxy('/proxy/')
});
const imageryLayer = new Cesium.ImageryLayer(provider);
viewer.imageryLayers.add(imageryLayer);
See:
Members
获取图像时应包含在 WMS URL 中的默认参数。值如下:
service=WMS
version=1.1.1
request=GetMap
styles=
format=image/jpeg
获取特征信息时应包含在 WMS URL 中的默认参数。值如下:
service=WMS
version=1.1.1
request=GetFeatureInfo
获取或设置一个时钟,用于获取时间动态参数的时间值。
readonly credit : Credit
获取此影像提供者处于活动状态时要显示的信用信息。通常用于致谢
影像的来源。
获取或设置一个值,指示是否启用特征选择。 如果为 true,
WebMapServiceImageryProvider#pickFeatures 将
调用 WMS 服务器上的 GetFeatureInfo 服务,并尝试解释响应中包含的特征。 如果为 false,
WebMapServiceImageryProvider#pickFeatures 将立即返回 undefined(表明没有可选特征)
而不与服务器进行通信。如果您知道您的数据
源不支持选择特征或不希望此提供者的特征可选,请将此属性设置为 false。
-
Default Value:
true
readonly errorEvent : Event
获取一个事件,当影像提供者遇到异步错误时触发。通过订阅
该事件,您将收到错误通知并可以潜在地从中恢复。事件监听器
会接收一个
TileProviderError 的实例。
readonly getFeatureInfoUrl : Resource|string
获取 WMS 服务器的 getFeatureInfo URL。
获取一个值,指示此影像提供者提供的图像是否包含 alpha 通道。
如果此属性为 false,则如果存在 alpha 通道将被忽略。
如果此属性为 true,任何没有 alpha 通道的图像将被视为其 alpha
在各处为 1.0。当此属性为 false 时,将减少内存使用
和纹理上传时间。
获取 WMS 图层的名称,以逗号分隔。
获取可以请求的最大细节级别。
获取可以请求的最小细节级别。
readonly proxy : Proxy
获取此提供者使用的代理。
readonly rectangle : Rectangle
获取此实例提供的影像的矩形范围(以弧度为单位)。
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果未定义,丢弃策略负责
通过其 shouldDiscardImage 函数过滤掉“缺失”瓦片。如果此函数
返回 undefined,则不会过滤任何瓦片。
获取每个瓦片的高度(以像素为单位)。
获取每个瓦片的宽度(以像素为单位)。
readonly tilingScheme : TilingScheme
获取此提供者使用的瓦片方案。
获取或设置用于获取时间动态参数的时间区间集合。每个
TimeInterval 的数据是一个对象,包含在
瓦片请求时使用的属性的键和值。
获取 WMS 服务器的 URL。
Methods
getTileCredits(x, y, level) → Array.<Credit>
获取在显示给定瓦片时要显示的信用信息。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片级别。 |
Returns:
在显示该瓦片时要显示的信用信息。
pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
异步确定在给定经度和纬度内的瓦片中是否存在特征(如果有的话)。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片级别。 |
longitude |
number | 要选取特征的经度。 |
latitude |
number | 要选取特征的纬度。 |
Returns:
一个关于选取特征的承诺,当异步
选取完成时解析。解析的值是
ImageryLayerFeatureInfo
实例的数组。如果在给定位置未找到特征,则数组可能为空。
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
请求给定瓦片的图像。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片级别。 |
request |
Request | optional 请求对象,仅供内部使用。 |
Returns:
有关图像的承诺,当图像可用时解析,或者
如果对服务器的活动请求太多,则返回 undefined,要求稍后重试该请求。
Type Definitions
WebMapServiceImageryProvider 构造函数的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
url |
Resource | string | WMS 服务的 URL。该 URL 支持与 UrlTemplateImageryProvider 相同的关键字。 |
||
layers |
string | 要包括的图层,以逗号分隔。 | ||
parameters |
object |
<optional> |
WebMapServiceImageryProvider.DefaultParameters | 要传递给 WMS 服务器的 GetMap URL 中的附加参数。 |
getFeatureInfoParameters |
object |
<optional> |
WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters | 要传递给 WMS 服务器的 GetFeatureInfo URL 中的附加参数。 |
enablePickFeatures |
boolean |
<optional> |
true | 如果为 true,WebMapServiceImageryProvider#pickFeatures 将调用
WMS 服务器的 GetFeatureInfo 操作,并返回响应中包含的特征。如果为 false,
WebMapServiceImageryProvider#pickFeatures 将立即返回 undefined(表示没有可选特征)
而不与服务器通信。如果您知道您的 WMS 服务器不支持
GetFeatureInfo 或者如果您不希望该提供者的特征可被选取,请将此属性设置为 false。请注意,这可以通过动态地
修改 WebMapServiceImageryProvider#enablePickFeatures 属性来覆盖。 |
getFeatureInfoFormats |
Array.<GetFeatureInfoFormat> |
<optional> |
WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats | 尝试 WMS GetFeatureInfo 请求的格式。 |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图层的矩形范围。 |
tilingScheme |
TilingScheme |
<optional> |
new GeographicTilingScheme() | 用于将世界分割为瓦片的瓦片方案。 |
ellipsoid |
Ellipsoid |
<optional> |
椭球体。如果指定了瓦片方案, 则忽略此参数,使用瓦片方案的椭球体。如果两个参数都未指定,则使用 WGS84 椭球体。 | |
tileWidth |
number |
<optional> |
256 | 每个瓦片的宽度(以像素为单位)。 |
tileHeight |
number |
<optional> |
256 | 每个瓦片的高度(以像素为单位)。 |
minimumLevel |
number |
<optional> |
0 | 地影提供者支持的最小细节级别。在指定时要注意,最低级别的瓦片数量应较少,例如四个或更少。较大的数量可能会导致呈现问题。 |
maximumLevel |
number |
<optional> |
地影提供者支持的最大细节级别,如果没有限制则为 undefined。 如果未指定,则没有限制。 | |
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> |
<optional> |
'abc' | 用于 URL 模板中的 {s} 占位符的子域。
如果此参数是单个字符串,则该字符串中的每个字符都是一个子域。如果是
数组,则数组中的每个元素都是一个子域。 |
clock |
Clock |
<optional> |
在确定时间维度的值时使用的 Clock 实例。当指定了 `times` 时需要。 | |
times |
TimeIntervalCollection |
<optional> |
其 data 属性为一个对象的 TimeIntervalCollection,包含时间动态维度及其值。 | |
getFeatureInfoUrl |
Resource | string |
<optional> |
WMS 服务的 getFeatureInfo URL。如果该属性未定义,则使用 url 的属性值。 |
