Class: WebMapServiceImageryProvider

WebMapServiceImageryProvider

new WebMapServiceImageryProvider()

用于加载符合 ‌WMS（Web Map Service）‌标准的地图服务类。

Name Type Default Description
options.url String

WMS 服务的 URL。该 URL 支持与 UrlTemplateImageryProvider 相同的关键字。
options.layers String

要包含的图层，用逗号分隔。
options.parameters Object WebMapServiceImageryProvider.DefaultParameters 可选

在 GetMap URL 中传递给 WMS 服务器的附加参数。
options.getFeatureInfoParameters Object WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters 可选

在 GetFeatureInfo URL 中传递给 WMS 服务器的附加参数。
options.enablePickFeatures Boolean true 可选

如果为true，WebMapServiceImageryProvider#pickFeatures将在WMS服务器上调用GetFeatureInfo操作并返回响应中包含的特征。 如果为false，WebMapServiceImageryProvider#pickFeatures将在不与服务器通信的情况下立即返回undefined(表示没有可选择的功能)。 如果您知道您的WMS服务器不支持GetFeatureInfo，或者您不希望此提供商的特性是可选择的，请将此属性设置为false。 注意，这可以通过修改WebMapServiceImageryProvider#enablePickFeatures属性来动态覆盖。
options.getFeatureInfoFormats Array.<GetFeatureInfoFormat> WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats 可选

尝试WMS GetFeatureInfo请求的格式。
options.rectangle Rectangle Rectangle.MAX_VALUE 可选

图层的矩形。
options.tilingScheme TilingScheme new GeographicTilingScheme() 可选

将地理划分为若干块的切片方案。
options.ellipsoid Ellipsoid 可选

椭球。如果指定了切片方案，则忽略此参数，而使用切片方案的椭球。如果不指定任何参数，则使用WGS84椭球。
options.tileWidth Number 256 可选

每个瓦片的宽度（像素）。
options.tileHeight Number 256 可选

每个瓦片的高度（像素）。
options.minimumLevel Number 0 可选

影像提供者支持的最小精细级别。指定时要注意，最小级别的瓦片数量要少，如四个或更少。如果数量较多，可能会导致渲染问题。
options.maximumLevel Number 可选

影像提供者支持的最大精细级别；如果没有限制，则未定义。如果未指定，则没有限制。
options.credit Credit | String 可选

数据源的版权声明，显示在画布上。
options.proxy Object 可选

用于请求的代理。如果需要，该对象应具有一个 getURL 函数，用于返回代理 URL。
options.subdomains String | Array.<String> 'abc' 可选

用于 URL 模板中 {s} 占位符的子域。如果该参数是单字符串，则字符串中的每个字符都是一个子域。如果是数组，数组中的每个元素都是一个子域。
See:
Example
var provider = new SuperMap3D.WebMapServiceImageryProvider({
    url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
    layers : '0',
    proxy: new SuperMap3D.DefaultProxy('/proxy/')
});

viewer.imageryLayers.addImageryProvider(provider);

Members

(static, constant) DefaultParametersObject

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

readonly creditCredit

获取该影像提供者激活时要显示的版权声明。通常情况下，这将用于标明影像来源。此函数不应在 WebMapServiceImageryProvider#ready 返回 true 之前调用。

customRequestHeadersObject

自定义请求头

enablePickFeaturesBoolean

获取或设置表示是否启用特征选择的值。如果为true，WebMapServiceImageryProvider#pickFeatures将调用WMS服务器上的GetFeatureInfo服务，并尝试解释响应中包含的地物信息。 如果设置为 false，WebMapServiceImageryProvider#pickFeatures将立即返回未定义（表示没有可选取的特征），而不会与服务器进行通信。 如果您知道您的数据源不支持选取特征，或者您不希望该提供程序的特征是可选取的，请将此属性设为 false。

Default Value:
true

readonly errorEventEvent

获取在影像提供程序遇到异步错误时引发的事件。通过订阅该事件，您将收到错误通知，并有可能从中恢复。事件侦听器会收到一个 TileProviderError 的实例。

readonly hasAlphaChannelBoolean

获取指示该影像提供程序提供的影像是否包含 alpha 通道的值。 如果该属性为 false，则会忽略存在的 alpha 通道。 如果该属性为 true，任何不包含 alpha 通道的影像都将被视为其 alpha 值为 1.0 的影像。 此属性为false时，内存使用量和纹理上传时间都会减少。

readonly layersString

获取 WMS 图层的名称，以逗号分隔。

readonly maximumLevelNumber

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

readonly minimumLevelNumber

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

readonly proxyProxy

获取该提供程序使用的代理。

readonly readyBoolean

获取表示提供程序是否可以使用的值。

readonly readyPromisePromise.<Boolean>

获取当提供程序准备就绪时解析为 true 的Promise。

readonly rectangleRectangle

获取此实例所提供影像的矩形（以弧度为单位）。此函数不应在 WebMapServiceImageryProvider#ready 返回 true 之前调用。

readonly tileDiscardPolicyTileDiscardPolicy

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

readonly tileHeightNumber

获取每个瓦片的高度（以像素为单位）。此函数不应在 WebMapServiceImageryProvider#ready 返回 true 之前调用。

readonly tileWidthNumber

获取每个瓦片的宽度（以像素为单位）。此函数不应在 WebMapServiceImageryProvider#ready 返回 true 之前调用。

readonly tilingSchemeTilingScheme

获取此提供程序使用的切片方案。此函数不应在 WebMapServiceImageryProvider#ready 返回 true 之前调用。

readonly urlString

获取 WMS 服务器的 URL。

Methods

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

获取显示给定瓦片时要显示的版权声明。

Name Type Description
x Number

瓦片的X坐标。
y Number

瓦片的Y坐标。
level Number

瓦片的级别。
Throws:

getTileCredits 不得在影像提供程序准备就绪前调用。

Type
DeveloperError
Returns:
Type Description
Array.<Credit> 显示瓦片时要的版权声明。

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

异步确定瓦片中给定经度和纬度处的地物（如果有的话）。该函数不应在 ImageryProvider#ready 返回 true 之前调用。

Name Type Description
x Number

瓦片的X坐标。
y Number

瓦片的Y坐标。
level Number

瓦片的级别。
longitude Number

选取特征的经度。
latitude Number

选取特征的纬度。
Throws:

pickFeatures 不得在影像提供程序准备就绪前调用。

Type
DeveloperError
Returns:
Type Description
Promise.<Array.<ImageryLayerFeatureInfo>> | undefined 当异步提取完成时，将解析所提取特征的Promise。 解析值是一个由 ImageryLayerFeatureInfo 实例组成的数组。 如果在给定位置未找到任何特征，数组可能为空。

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 可选

请求对象。仅供内部使用。
Throws:

requestImage 不得在影像提供程序准备就绪前调用。

Type
DeveloperError
Returns:
Type Description
Promise.<(Image|Canvas)> | undefined 影像的Promise，该Promise将在影像可用时解析该影像；如果服务器上有太多活动请求，则未定义该Promise，请求应稍后重试。解析的影像可以是影像或 Canvas DOM 对象。