提供由 Web Map Service(WMS)服务器托管的瓦片影像。
| Name | Type | Description |
|---|---|---|
options |
WebMapServiceImageryProvider.ConstructorOptions | Object describing initialization options |
Example:
// WMS servers operated by the US government https://apps.nationalmap.gov/services/
const provider = new Cesium.WebMapServiceImageryProvider({
url : 'https://basemap.nationalmap.gov:443/arcgis/services/USGSHydroCached/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
获取或设置一个时钟(clock),用于获取并保持时间动态参数所使用的时间。
readonly credit : Credit
获取当此影像提供者处于活动状态时要显示的版权信息(credit)。通常这用于标注影像的来源。
获取或设置一个指示是否启用要素拾取(feature picking)的值。如果为 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 图层名称。
获取可请求的最大细节层次(level-of-detail)。
获取可请求的最小细节层次(level-of-detail)。
readonly proxy : Proxy
获取此提供者使用的代理(proxy)。
readonly rectangle : Rectangle
获取此实例提供的影像的矩形区域,以弧度表示。
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略(tile discard policy)。如果不为 undefined,该丢弃策略负责通过其 shouldDiscardImage 函数过滤掉“缺失”的瓦片。如果该函数返回 undefined,则不会过滤任何瓦片。
获取每个瓦片的高度,以像素为单位。
获取每个瓦片的宽度,以像素为单位。
readonly tilingScheme : TilingScheme
获取此提供者使用的分块方案(tiling scheme)。
获取或设置一个时间间隔集合(TimeIntervalCollection),用于获取时间动态参数。每个 TimeInterval 的数据是一个对象,包含瓦片请求期间所使用的属性的键和值。
获取 WMS 服务器的 URL。
Methods
getTileCredits(x, y, level) → Array.<Credit>
获取在显示给定瓦片时要显示的版权信息(credits)。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层次(level); |
Returns:
在显示该瓦片时要显示的版权信息(credits)。
pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
异步确定在给定的经度和纬度处(位于某个瓦片内)存在哪些要素(如果有)。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层次(level)。 |
longitude |
number | 拾取要素所在的经度。 |
latitude |
number | 拾取要素所在的纬度。 |
Returns:
一个用于已拾取要素的 promise,将在异步拾取完成时解析。解析后的值是一个由
ImageryLayerFeatureInfo 实例组成的数组。如果在给定位置未找到任何要素,该数组可能为空。
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
请求给定瓦片的图像。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层次(level)。 |
request |
Request | optional 请求对象。仅供内部使用。 |
Returns:
一个用于图像的 promise,将在图像可用时解析;如果到服务器的活动请求过多,请求应稍后重试,则返回 undefined。
Type Definitions
Initialization options for the WebMapServiceImageryProvider constructor
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
url |
Resource | string | WMS 服务的 URL。该 URL 支持与 UrlTemplateImageryProvider 相同的关键字。 |
||
layers |
string | 要包含的图层,以逗号分隔。 | ||
parameters |
object |
<optional> |
WebMapServiceImageryProvider.DefaultParameters | 在 GetMap URL 中传递给 WMS 服务器的附加参数。 |
enablePickFeatures |
boolean |
<optional> |
true | 如果为 true,WebMapServiceImageryProvider#pickFeatures 会调用 WMS 服务器上的 GetFeatureInfo 操作,并返回响应中包含的要素。如果为 false,WebMapServiceImageryProvider#pickFeatures 会立即返回 undefined(表示无可拾取要素),而不与服务器通信。如果您知道 WMS 服务器不支持 GetFeatureInfo,或者不希望此提供者的要素可被拾取,请将此属性设为 false。注意,这可以通过修改 WebMapServiceImageryProvider#enablePickFeatures 属性来动态覆盖。 |
getFeatureInfoParameters |
object |
<optional> |
WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters | 在 GetFeatureInfo URL 中传递给 WMS 服务器的附加参数。 |
getFeatureInfoUrl |
Resource | string |
<optional> |
WMS 服务的 getFeatureInfo URL。如果未定义该属性,则使用 url 属性的值。 | |
getFeatureInfoFormats |
Array.<GetFeatureInfoFormat> |
<optional> |
WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats | 尝试 WMS GetFeatureInfo 请求时使用的格式。 |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图层的矩形区域。 |
tilingScheme |
TilingScheme |
<optional> |
new GeographicTilingScheme() | 用于将世界划分为瓦片的分块方案(tiling scheme)。 |
ellipsoid |
Ellipsoid |
<optional> |
椭球体。如果指定了 tilingScheme,则此参数将被忽略,转而使用分块方案的椭球体。如果两个参数都未指定,则使用 WGS84 椭球体。 | |
tileWidth |
number |
<optional> |
256 | 每个瓦片的宽度,以像素为单位。 |
tileHeight |
number |
<optional> |
256 | 每个瓦片的高度,以像素为单位。 |
minimumLevel |
number |
<optional> |
0 | 影像提供者支持的最小细节层次(level-of-detail)。指定此值时请注意,最小级别处的瓦片数量应较小,例如四个或更少。较大的数量可能会导致渲染问题。 |
maximumLevel |
number |
<optional> |
影像提供者支持的最大细节层次(level-of-detail),如果没有限制则为 undefined。如果未指定,则没有限制。 | |
crs |
string |
<optional> |
CRS 规范,用于 WMS 规范 >= 1.3.0。 | |
srs |
string |
<optional> |
SRS 规范,用于 WMS 规范 1.1.0 或 1.1.1 | |
credit |
Credit | string |
<optional> |
数据源的版权信息(credit),显示在画布上。 | |
subdomains |
string | Array.<string> |
<optional> |
'abc' | 用于 URL 模板中 {s} 占位符的子域(subdomains)。如果此参数是一个字符串,则字符串中的每个字符都是一个子域。如果是一个数组,则数组中的每个元素都是一个子域。 |
clock |
Clock |
<optional> |
在确定时间维度的值时所使用的 Clock 实例。当指定 `times` 时为必填。 | |
times |
TimeIntervalCollection |
<optional> |
TimeIntervalCollection,其 data 属性为一个包含时间动态维度及其值的对象。 |
