提供由 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/')
});
viewer.imageryLayers.addImageryProvider(provider);
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
当此图像提供程序处于活动状态时,获得要显示的功劳。通常,这用于说明图像的来源。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
此提供程序的默认 alpha 混合值,0.0 表示完全透明,1.0 表示完全不透明。
-
Default Value:
undefined
此提供程序的默认亮度。 1.0 使用未修改的图像颜色。小于 1.0 会使图像更暗,而大于 1.0 会使图像更亮。
-
Default Value:
undefined
此提供程序的默认对比度。 1.0 使用未修改的图像颜色。小于 1.0 会降低对比度,而大于 1.0 会增加对比度。
-
Default Value:
undefined
此提供程序的地球日侧的默认 alpha 混合值,0.0 表示完全透明,1.0 表示完全不透明。
-
Default Value:
undefined
应用于此提供程序的默认伽马校正。 1.0 使用未修改的图像颜色。
-
Default Value:
undefined
此提供程序的默认色调(以弧度为单位)。 0.0 使用未修改的图像颜色。
-
Default Value:
undefined
defaultMagnificationFilter : TextureMagnificationFilter
应用于此提供程序的默认纹理放大过滤器。
-
Default Value:
undefined
defaultMinificationFilter : TextureMinificationFilter
应用于此提供程序的默认纹理缩小过滤器。
-
Default Value:
undefined
此提供程序的地球夜晚的默认 alpha 混合值,0.0 表示完全透明,1.0 表示完全不透明。
-
Default Value:
undefined
此提供程序的默认饱和度。 1.0 使用未修改的图像颜色。小于 1.0 会降低饱和度,而大于 1.0 会增加饱和度。
-
Default Value:
undefined
获取或设置一个值,该值指示是否启用特征选择。如果为 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 通道(如果存在)将被忽略。如果此属性为真,则任何没有 alpha 通道的图像都将被视为其 alpha 在任何地方都是 1.0。当此属性为 false 时,内存使用量和纹理上传时间会减少。
获取 WMS 图层的名称,以逗号分隔。
获取可以请求的最大细节级别。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
获取可以请求的最低详细级别。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
readonly proxy : Proxy
获取此提供程序使用的代理。
获取一个值,该值指示提供程序是否已准备好使用。
当提供者准备好使用时,获取一个解析为 true 的承诺。
readonly rectangle : Rectangle
获取此实例提供的图像的矩形(以弧度为单位)。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果未定义,丢弃策略负责通过其 shouldDiscardImage 函数过滤掉'丢失的'图块。如果此函数返回未定义,则不过滤任何图块。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
获取每个图块的高度,以像素为单位。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
获取每个图块的宽度,以像素为单位。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
readonly tilingScheme : TilingScheme
获取此提供程序使用的切片方案。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
获取或设置用于获取时间动态参数的时间间隔集合。每个 TimeInterval 的数据是一个对象,其中包含在磁贴请求期间使用的属性的键和值。
获取 WMS 服务器的 URL。
Methods
getTileCredits (x, y, level) → Array.< Credit >
获取显示给定磁贴时要显示的积分。
Name | Type | Description |
---|---|---|
x
|
Number | 平铺 X 坐标。 |
y
|
Number | 瓦片 Y 坐标。 |
level
|
Number | 瓷砖级别; |
Returns:
显示磁贴时要显示的学分。
Throws:
-
DeveloperError : 在图像提供程序准备好之前,不得调用
getTileCredits
。
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 | 选择要素的纬度。 |
Returns:
异步拾取完成时将解决的拾取特征的承诺。解析的值是
ImageryLayerFeatureInfo
实例的数组。如果在给定位置未找到任何特征,则该数组可能为空。
Throws:
-
DeveloperError : 在图像提供程序准备好之前,不得调用
pickFeatures
。
requestImage (x, y, level, request ) → Promise.< ImageryTypes >|undefined
请求给定图块的图像。在
WebMapServiceImageryProvider#ready
返回 true 之前不应调用此函数。
Name | Type | Description |
---|---|---|
x
|
Number | 平铺 X 坐标。 |
y
|
Number | 瓦片 Y 坐标。 |
level
|
Number | 瓷砖级别。 |
request
|
Request | 可选 请求对象。仅供内部使用。 |
Returns:
对图像的承诺,当图像可用时将解析,或者如果对服务器的活动请求过多,则未定义,并且应稍后重试请求。
Throws:
-
DeveloperError :在图像提供程序准备好之前,不得调用
requestImage
。
Type Definitions
WebMapServiceImageryProvider 构造函数的初始化选项
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
url
|
Resource | String |
WMS 服务的 URL。 URL 支持与
UrlTemplateImageryProvider
相同的关键字。
|
||
layers
|
String | 要包含的层,用逗号分隔。 | ||
parameters
|
Object |
<optional>
|
WebMapServiceImageryProvider.DefaultParameters | 在 GetMap URL 中传递给 WMS 服务器的附加参数。 |
getFeatureInfoParameters
|
Object |
<optional>
|
WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters | 在 GetFeatureInfo URL 中传递给 WMS 服务器的附加参数。 |
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>
|
椭球体。如果指定了 tilingScheme,则忽略此参数,并使用切片方案的椭球代替。如果两个参数均未指定,则使用 WGS84 椭球。 | |
tileWidth
|
Number |
<optional>
|
256 | 每个图块的宽度(以像素为单位)。 |
tileHeight
|
Number |
<optional>
|
256 | 每个图块的高度(以像素为单位)。 |
minimumLevel
|
Number |
<optional>
|
0 | 图像提供者支持的最低详细程度。指定时请注意,最小级别的图块数量很少,例如四个或更少。较大的数字可能会导致渲染问题。 |
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> |
<optional>
|
'abc' |
用于 URL 模板中
{s}
占位符的子域。如果此参数是单个字符串,则字符串中的每个字符都是一个子域。如果是数组,则数组中的每个元素都是一个子域。
|
clock
|
Clock |
<optional>
|
在确定时间维度的值时使用的 Clock 实例。指定 `times` 时需要。 | |
times
|
TimeIntervalCollection |
<optional>
|
TimeIntervalCollection 及其数据属性是一个包含时间动态维度及其值的对象。 | |
getFeatureInfoUrl
|
Resource | String |
<optional>
|
WMS 服务的 getFeatureInfo URL。如果没有定义属性,那么我们使用 url 的属性值。 |