Common Cesium-Plugin MapboxGL-Plugin Leaflet-Plugin OpenLayers-Plugin Video-Plugin
API文档
类名 WMSLayer

# new WMSLayer(options)

WMS图层，
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，会自动读取元信息上的坐标系，不需要用户指定，同时所有的WMS服务都支持动态投影，用户也可指定任意该服务支持的坐标系

[ES5引入方式]：
zondy.layer.WMSLayer()
[ES6引入方式]：
import { WMSLayer } from "@mapgis/webclient-common"

针对图层的操作请在图层加载完毕事件中进行
Layer.on('layerview-created', function (result) {
console.log("加载完毕:", result.layer)
});
如果不想在该事件中放入业务代码，则请确认图层资源已加载完毕后再进行操作
if(layer.loadStatus === 'loaded') {
// 你的业务逻辑
}

参数:

名称 类型 默认值 描述
options Object

构造参数
url String

服务基地址，支持的服务如下：
1、支持MapGIS的WMS服务，格式为： 1.1、IGS1.0: http://{ip}:{port}/igs/rest/ogc/doc/{folder}:{serviceName}/WMSServer，
1.2、IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/WMSServer，参考示例：[加载MapGIS的WMS服务]
2、支持ArcGIS的WMS服务，格式为：http://{ip}:{port}/arcgis/rest/services/{ServiceName}/WMSServer，参考示例：[加载ArcGIS的WMS服务]
title String

图层名称
spatialReference SpatialReference

图层坐标系，支持4326、3857以及EPSG上的自定义坐标系，坐标系默认从元信息中获取，也可指定坐标系， 参考示例：[设置图层坐标系]
opacity Number 1

图层透明度，0到1之间的值，0为完全透明，1为不透明，参考示例：[设置图层透明度]
visible Boolean true

图层显示或隐藏，true则显示，false则隐藏，参考示例：[设置图层显隐]
imageWidth Number 256

图片宽度，单位px
imageHeight Number 256

图片高度，单位px
minScale Number 0

最小显示比例尺，图层在视图中可见的最小比例尺。
maxScale Number 0

最大显示比例尺，图层在视图中可见的最大比例尺。
imageTransparency Boolean true

图片中没有数据的地方是否透明，默认为true，即透明
clippingArea Polygon | Extent | Circle | MultiPolygon | null null

图层空间裁剪范围，仅支持多多边形裁剪、多边形裁剪、矩形裁剪、圆形裁剪
sublayers Array

指定子图层参数，可设置子图层是否显示，若不填则显示所有子图层，若有值则只显示visible为true的子图层，
参考示例：
[1、初始化时，设置子图层显隐]
[2、通过方法，设置子图层显隐]
[3、通过修改子图参数，设置子图层显隐]
tokenKey String 'token'

token名
tokenValue String

token值，只有当tokenValue存在时，才会绑定token
renderMode String 'tile'

影像的展现形式。可选'tile' 、 'image'。默认为'tile'，加载影像时以瓦片的方式平铺。当选项为'image'时，加载影像会请求一张覆盖当前屏幕的图像。

支持如下方法：
[1、加载图层资源]
[2、设置子图层参数]
[3、根据子图层id查询图层]
[4、通过传入的json构造并返回一个新的几何对象]
5、导出为json对象
6、克隆几何对象

示例

添加WMS图层示例

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化wms图层
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer'
});

设置图层透明度

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化时设置
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer',
 // 设置透明度
  opacity: 1.0
});

显示或隐藏图层

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化时设置
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer',
  // 显示或隐藏图层
  visible: true
});

设置图层坐标系

// ES5引入方式
const { WMSLayer } = zondy.layer
const { SpatialReference } = zondy
// ES6引入方式
import { WMSLayer, SpatialReference } from "@mapgis/webclient-common"
// 初始化wms图层
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer',
  // 指定图层坐标系
  spatialReference: new SpatialReference({
    // 坐标系的wkid，可在https://epsg.io/网站查询
    wkid: 4326
  })
});

删除图层

map.remove(wmsLayer)

添加ArcGIS的WMS图层示例

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
  url: 'http://219.142.81.85/arcgis/rest/services/10wanZH/MapServer/WMSServer',
  // 注意一个WMS图层可能支持多个坐标系，这里指定3857坐标系
  spatialReference: new zondy.SpatialReference({
    wkid: 3857
  })
});

初始化时，设置子图层显隐

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer',
  // 要显示的子图层，若不填，则默显示所有子图层
  sublayers: [{
    id: 0,
    visible: true
  }, {
    id: 1,
    visible: true
  }]
});

通过修改子图参数，设置子图层显隐

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
});

// 根据id获取子图层
const wmsSubLayer = wmsLayer.findSublayerById(0)
// 设置子图层显隐
wmsSubLayer.visible = false

继承关系

成员变量

Collection

# readonly allSublayers

所有子图层对象信息

Object

# readonly capabilities

图层支持能力。图层支持能力分为客户端能力和服务端能力，其中客户端能力包含cesium、leaflet、mapboxgl引擎能力。默认图层客户端能力：所有引擎支持图层加载；默认图层服务端能力为空。

Overrides:
Polygon | Extent | Circle | MultiPolygon | null

# clippingArea

空间裁剪范围

String

版权所有

Inherited From:
Object

# customParameters

自定义查询参数customParameters

Inherited From:
String

# readonly description

图层描述

Inherited From:
Object

# extendProps

当前图层对象上不支持的属性，二次开发用户希望挂在图层对像上的属性可以存储到该属性中

Inherited From:
Default Value:
  • {}
Object

# extensionOptions

初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数

Inherited From:
Default Value:
  • {}
Extent | null

# readonly extent

图层的范围。从元信息或数据中获取，默认为null表示取不到范围。

Inherited From:
String

# readonly headers

设置服务请求头

Inherited From:
FetchMethod

# readonly httpMethod

http请求方式

Inherited From:
String

# readonly id

图层id

Inherited From:
String

# imageFormat

图片格式

Array

# readonly imageFormats

图片格式数组，表示服务支持的所有图片格式

Number

# imageHeight

图片高度，单位px

Boolean

# imageTransparency

图层中的非数据部分是否透明

Number

# imageWidth

图片宽度，单位px

Boolean

# readonly loaded

是否加载完毕

Inherited From:
Default Value:
  • false
String

# readonly loadStatus

图层加载状态

Inherited From:
Default Value:
  • not-loaded
Number

# maxScale

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。maxScale应该始终小于minScale。

Inherited From:
Default Value:
  • 0
Number

# minScale

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。minScale应该始终大于maxScale。

Inherited From:
Default Value:
  • 0
Number

# opacity

图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。

Inherited From:
String

# readonly renderMode

影像的展现形式。可选'tile' 、 'image'。默认为'tile'，加载影像时以瓦片的方式平铺。当选项为'image'时，加载影像会请求一张覆盖当前屏幕的图像。

SpatialReference | null

# spatialReference

图层坐标系对象

Inherited From:
Array.<SpatialReference>

# readonly spatialReferences

图层支持的所有坐标系

Collection | null | Object

# sublayers

所有子图层对象信息

String

# title

图层名称

Inherited From:
TokenAttachType

# tokenAttachType

token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾

Inherited From:
String

# tokenKey

token名

Inherited From:
Default Value:
  • token
String

# tokenValue

token值

Inherited From:
LayerType

# readonly type

图层类型

Overrides:
String

# readonly url

服务基地址

String

# readonly version

WMS服务版本号

Overrides:
Number

# visible

图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件

Inherited From:

方法

# static fromJSON(json)

通过json构造WMSLayer对象

参数:

名称 类型 描述
json Object

json对象

WMSLayer实例

WMSLayer

# static fromServerUrl(url)

通过url创建图层对象

参数:

名称 类型 描述
url String

服务基地址

新的图层对象

WMSLayer

# clone()

克隆WMSLayer对象

Overrides:

克隆后的WMSLayer实例

WMSLayer

# destroy()

Inherited From:
*

# findSublayerById(sublayerID)

根据子图层id查询图层

参数:

名称 类型 描述
sublayerID String

图层ID

子图层

WMSSubLayer | null
示例

根据子图层id查询图层

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
});
map.add(wmsLayer);
// 根据id获取子图层
const wmsSubLayer = wmsLayer.findSublayerById(0)

# isLoaded()

判断图层是否加载成功

Inherited From:

图层是否加载成功

Boolean

# load()

加载图层资源

示例

不加载图层，仅获取图层信息

// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化图层
const wmsLayer = new WMSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer'
});
wmsLayer.load().then((result) => {
  // 获取完图层信息
  console.log(wmsLayer)
})

# toJSON()

转换为json对象

Overrides:

json对象

Object

事件

# 图层加载完毕事件

图层加载完毕事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-created'

图层加载完毕事件
message String <optional>
 null

更新描述
UpdateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层加载完毕事件

Layer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
});

# 图层显隐更新完毕事件

图层显隐更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层显隐更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层显隐事件
    if(updateContent[i].name === 'visible'){
      console.log("图层显隐更新事件:", event);
    }
  }
});

# 图层更新完毕事件

图层更新完毕事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层更新完毕事件

Layer.on('layerview-update', function (result) {
  console.log("更新完毕:", result.layer)
});

# 图层比例尺显示隐藏状态更新事件。当前仅支持非组图层以及场景子图层

图层刷新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
event LayerViewScaleVisibleEvent

事件对象 layer.on('layerview-scale-visible', (event) => { console.log("图层比例尺显示隐藏状态更新事件:", event) })
Inherited From:
示例

图层刷新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层刷新完毕事件
    if(updateContent[i].name === 'refresh'){
      console.log("图层刷新完毕事件:", event);
    }
  }
});

/**

# 图层透明度更新完毕事件

图层透明度更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层透明度更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层透明度更新事件
    if(updateContent[i].name === 'opacity'){
      console.log("图层透明度更新事件:", event);
    }
  }
});

# 图层销毁完毕事件

图层销毁完毕事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-remove'

图层销毁完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

要销毁的地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层销毁完毕事件

Layer.on('layerview-remove', function (result) {
  console.log("销毁完毕:", result.layer)
});

# 子图层显隐更新完毕事件

子图层显隐更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
示例

子图层显隐更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 子图层显隐更新完毕事件
    if(updateContent[i].name === 'sublayerVisible'){
      console.log("子图层显隐更新完毕事件:", event);
    }
  }
});
构造函数
成员变量
方法
事件