提供由 Web 地图服务 (WMS) 服务器托管的平铺图像。 Provides tiled imagery hosted by a Web Map Service (WMS) server.
| 名称 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 The default parameters to include in the WMS URL to obtain images. The values are as follows: service=WMS version=1.1.1 request=GetMap styles= format=image/jpeg
WMS URL 中包含的默认参数以获取要素信息。值如下： service=WMS version=1.1.1 request=GetFeatureInfo The default parameters to include in the WMS URL to get feature information. The values are as follows: service=WMS version=1.1.1 request=GetFeatureInfo
获取或设置一个时钟，用于获取保存时间动态参数所用的时间。 Gets or sets a clock that is used to get keep the time used for time dynamic parameters.
readonly credit : Credit
获取此图像提供程序处于活动状态时要显示的信用。通常，这用于证明图像的来源。 Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.
获取或设置一个值，该值指示是否启用特征拾取。如果属实的话， Gets or sets a value indicating whether feature picking is enabled. If true,
WebMapServiceImageryProvider#pickFeatures 将调用 will invoke the GetFeatureInfo WMS 服务器上的服务并尝试解释响应中包含的功能。如果是假的， service on the WMS server and attempt to interpret the features included in the response. If false,
WebMapServiceImageryProvider#pickFeatures 将立即返回未定义（表示没有可选择的功能），而不与服务器通信。如果您知道您的数据源不支持选择功能或者您不希望该提供程序的功能可供选择，请将此属性设置为 false。 will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your data source does not support picking features or if you don't want this provider's features to be pickable.
-
默认值： Default Value:
true
readonly errorEvent : Event
获取当图像提供程序遇到异步错误时引发的事件。通过订阅该事件，您将收到错误通知，并有可能从中恢复。事件监听器传递一个实例 Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of
TileProviderError.
readonly getFeatureInfoUrl : Resource|string
获取 WMS 服务器的 getFeatureInfo URL。 Gets the getFeatureInfo URL of the WMS server.
获取一个值，该值指示此图像提供程序提供的图像是否包含 Alpha 通道。如果此属性为 false，则 Alpha 通道（如果存在）将被忽略。如果此属性为 true，则任何没有 Alpha 通道的图像都将被视为其 Alpha 在任何地方都是 1.0。当此属性为 false 时，内存使用量和纹理上传时间都会减少。 Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are reduced.
获取 WMS 图层的名称，以逗号分隔。 Gets the names of the WMS layers, separated by commas.
获取可以请求的最大详细程度。 Gets the maximum level-of-detail that can be requested.
获取可以请求的最低详细程度。 Gets the minimum level-of-detail that can be requested.
readonly proxy : Proxy
获取此提供者使用的代理。 Gets the proxy used by this provider.
readonly rectangle : Rectangle
获取此实例提供的图像的矩形（以弧度为单位）。 Gets the rectangle, in radians, of the imagery provided by this instance.
readonly tileDiscardPolicy : TileDiscardPolicy
获取图块丢弃策略。如果未定义，则丢弃策略负责通过其 shouldDiscardImage 函数过滤掉“丢失”的图块。如果此函数返回未定义，则不会过滤任何图块。 Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered.
获取每个图块的高度（以像素为单位）。 Gets the height of each tile, in pixels.
获取每个图块的宽度（以像素为单位）。 Gets the width of each tile, in pixels.
readonly tilingScheme : TilingScheme
获取此提供程序使用的切片方案。 Gets the tiling scheme used by this provider.
获取或设置用于获取时间动态参数的时间间隔集合。每个 TimeInterval 的数据是一个对象，其中包含在图块请求期间使用的属性的键和值。 Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each TimeInterval is an object containing the keys and values of the properties that are used during tile requests.
获取 WMS 服务器的 URL。 Gets the URL of the WMS server.
方法 Methods
getTileCredits(x, y, level) → Array.<Credit>
获取显示给定图块时要显示的积分。 Gets the credits to be displayed when a given tile is displayed.
| 名称 Name | 类型 Type | 说明 Description |
|---|---|---|
x |
number | 平铺 X 坐标。 The tile X coordinate. |
y |
number | 平铺 Y 坐标。 The tile Y coordinate. |
level |
number | 瓷砖水平； The tile level; |
返回： Returns:
显示图块时要显示的制作人员名单。 The credits to be displayed when the tile is displayed.
pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
异步确定哪些要素（如果有）位于切片内给定经度和纬度处。 Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile.
| 名称 Name | 类型 Type | 说明 Description |
|---|---|---|
x |
number | 平铺 X 坐标。 The tile X coordinate. |
y |
number | 平铺 Y 坐标。 The tile Y coordinate. |
level |
number | 瓷砖级别。 The tile level. |
longitude |
number | 选择要素的经度。 The longitude at which to pick features. |
latitude |
number | 选择特征的纬度。 The latitude at which to pick features. |
返回： Returns:
对所选取功能的承诺将在异步选取完成时解决。解析后的值是一个数组 A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of
ImageryLayerFeatureInfo
实例。如果在给定位置未找到要素，则数组可能为空。 instances. The array may be empty if no features are found at the given location.
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
请求给定图块的图像。 Requests the image for a given tile.
| 名称 Name | 类型 Type | 说明 Description |
|---|---|---|
x |
number | 平铺 X 坐标。 The tile X coordinate. |
y |
number | 平铺 Y 坐标。 The tile Y coordinate. |
level |
number | 瓷砖级别。 The tile level. |
request |
Request | 可选 optional 请求对象。仅供内部使用。 The request object. Intended for internal use only. |
返回： Returns:
对图像的承诺，该承诺将在图像可用时解析，或者如果对服务器的活动请求太多，则未定义，并且应稍后重试该请求。 A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later.
类型定义 Type Definitions
WebMapServiceImageryProvider 构造函数的初始化选项 Initialization options for the WebMapServiceImageryProvider constructor
属性： Properties:
| 名称 Name | 类型 Type | Attributes | 默认值 Default | 说明 Description |
|---|---|---|---|---|
url |
Resource | string | WMS 服务的 URL。该 URL 支持与以下相同的关键字 The URL of the WMS service. The URL supports the same keywords as the UrlTemplateImageryProvider. |
||
layers |
string | 要包含的层，以逗号分隔。 The layers to include, separated by commas. | ||
parameters |
object |
<可选> <optional> |
WebMapServiceImageryProvider.DefaultParameters | 在 GetMap URL 中传递到 WMS 服务器的其他参数。 Additional parameters to pass to the WMS server in the GetMap URL. |
enablePickFeatures |
boolean |
<可选> <optional> |
true | 如果属实的话， If true, WebMapServiceImageryProvider#pickFeatures 将调用 WMS 服务器上的 GetFeatureInfo 操作并返回响应中包含的要素。如果是假的， will invoke the GetFeatureInfo operation on the WMS server and return the features included in the response. If false,
WebMapServiceImageryProvider#pickFeatures 将立即返回未定义（表示没有可选择的功能），而不与服务器通信。如果您知道 WMS 服务器不支持 GetFeatureInfo 或者您不希望选择此提供程序的功能，请将此属性设置为 false。请注意，可以通过修改 WebMapServiceImageryProvider#enablePickFeatures 属性来动态覆盖它。 will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your WMS server does not support GetFeatureInfo or if you don't want this provider's features to be pickable. Note that this can be dynamically overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property. |
getFeatureInfoParameters |
object |
<可选> <optional> |
WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters | 要在 GetFeatureInfo URL 中传递到 WMS 服务器的其他参数。 Additional parameters to pass to the WMS server in the GetFeatureInfo URL. |
getFeatureInfoUrl |
Resource | string |
<可选> <optional> |
WMS 服务的 getFeatureInfo URL。如果未定义该属性，则我们使用 url 的属性值。 The getFeatureInfo URL of the WMS service. If the property is not defined then we use the property value of url. | |
getFeatureInfoFormats |
Array.<GetFeatureInfoFormat> |
<可选> <optional> |
WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats | 尝试 WMS GetFeatureInfo 请求的格式。 The formats in which to try WMS GetFeatureInfo requests. |
rectangle |
Rectangle |
<可选> <optional> |
Rectangle.MAX_VALUE | 图层的矩形。 The rectangle of the layer. |
tilingScheme |
TilingScheme |
<可选> <optional> |
新的地理切片方案() new GeographicTilingScheme() | 用于将世界划分为图块的切片方案。 The tiling scheme to use to divide the world into tiles. |
ellipsoid |
Ellipsoid |
<可选> <optional> |
椭球体。如果指定了 tilingScheme，则忽略此参数并使用切片方案的椭球体。如果两个参数均未指定，则使用 WGS84 椭球体。 The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used. | |
tileWidth |
number |
<可选> <optional> |
256 | 每个图块的宽度（以像素为单位）。 The width of each tile in pixels. |
tileHeight |
number |
<可选> <optional> |
256 | 每个图块的高度（以像素为单位）。 The height of each tile in pixels. |
minimumLevel |
number |
<可选> <optional> |
0 | 图像提供商支持的最低细节级别。指定此选项时请注意，最低级别的图块数量较小，例如四个或更少。数量过多可能会导致渲染问题。 The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems. |
maximumLevel |
number |
<可选> <optional> |
图像提供者支持的最大细节级别，如果没有限制则未定义。如果没有指定，则没有限制。 The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. If not specified, there is no limit. | |
crs |
string |
<可选> <optional> |
CRS 规范，与 WMS 规范 >= 1.3.0 一起使用。 CRS specification, for use with WMS specification >= 1.3.0. | |
srs |
string |
<可选> <optional> |
SRS规范，与WMS规范1.1.0或1.1.1一起使用 SRS specification, for use with WMS specification 1.1.0 or 1.1.1 | |
credit |
Credit | string |
<可选> <optional> |
数据源的来源，显示在画布上。 A credit for the data source, which is displayed on the canvas. | |
subdomains |
string | Array.<string> |
<可选> <optional> |
'abc' | 用于的子域 The subdomains to use for the {s} URL 模板中的占位符。如果此参数是单个字符串，则字符串中的每个字符都是一个子域。如果是数组，则数组中的每个元素都是一个子域。 placeholder in the URL template. If this parameter is a single string, each character in the string is a subdomain. If it is an array, each element in the array is a subdomain. |
clock |
Clock |
<可选> <optional> |
确定时间维度值时使用的 Clock 实例。指定“times”时需要。 A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified. | |
times |
TimeIntervalCollection |
<可选> <optional> |
TimeIntervalCollection 的 data 属性是一个包含时间动态维度及其值的对象。 TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values. |