Class: WMSLayer

// 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)

// 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

Extends

• OGCLayer

Members

allSublayersCollection

所有子图层对象信息

capabilitiesObject

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

clippingAreaPolygon Extent Circle MultiPolygon null

空间裁剪范围

copyrightString

版权所有

customParametersObject

自定义查询参数customParameters

descriptionString

图层描述

extendPropsObject

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

Default Value:

{}

Events

inherited 图层加载完毕事件

document/layer/baseLayer/Layer.js, line 46

图层加载完毕事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-created' 可选 图层加载完毕事件 message String null 可选 更新描述 UpdateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层加载完毕事件

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

inherited 图层显隐更新完毕事件

document/layer/baseLayer/Layer.js, line 90

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

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层显隐更新完毕事件

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);
    }
  }
});

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

document/layer/baseLayer/Layer.js, line 144

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

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象
event	LayerViewScaleVisibleEvent	事件对象 layer.on('layerview-scale-visible', (event) => { console.log("图层比例尺显示隐藏状态更新事件:", event) })

Example

图层刷新完毕事件

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);
    }
  }
});

/**

inherited 图层视图更新事件

document/layer/baseLayer/Layer.js, line 80

图层视图更新事件

Properties:

Name	Type	Description
event	LayerViewUpdateEvent	事件对象

Example

图层更新完毕事件

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

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

document/layer/baseLayer/Layer.js, line 117

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

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层透明度更新完毕事件

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);
    }
  }
});

inherited 图层销毁完毕事件

document/layer/baseLayer/Layer.js, line 63

图层销毁完毕事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-remove' 可选 图层销毁完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 要销毁的地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层销毁完毕事件

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

子图层显隐更新完毕事件

document/layer/ogc/WMSLayer.js, line 192

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

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

子图层显隐更新完毕事件

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);
    }
  }
});

Methods

WMSLayer.fromJSON(json){WMSLayer}

document/layer/ogc/WMSLayer.js, line 848

通过json构造WMSLayer对象

Name	Type	Description
json	Object	json对象

Returns:

Type	Description
WMSLayer	WMSLayer实例

WMSLayer.fromServerUrl(url){WMSLayer}

document/layer/ogc/WMSLayer.js, line 897

通过url创建图层对象

Name	Type	Description
url	String	服务基地址

Returns:

Type	Description
WMSLayer	新的图层对象

clone(){WMSLayer}

document/layer/ogc/WMSLayer.js, line 857

克隆WMSLayer对象

Returns:

Type	Description
WMSLayer	克隆后的WMSLayer实例

inherited destroy(){*}

document/layer/baseLayer/Layer.js, line 618

Returns:

Type	Description
*

findSublayerById(sublayerID){WMSSubLayer|null}

document/layer/ogc/WMSLayer.js, line 809

根据子图层id查询图层

Name	Type	Description
sublayerID	String	图层ID

Returns:

Type	Description
WMSSubLayer | null	子图层

Example

根据子图层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)

inherited getProperty(path){*}

document/layer/baseLayer/Layer.js, line 818

获取属性

Name	Type	Description
path	String

Returns:

Type	Description
*	属性值

inherited isLoaded(){Boolean}

document/layer/baseLayer/Layer.js, line 543

判断图层是否加载成功

Returns:

Type	Description
Boolean	图层是否加载成功

load()

document/layer/ogc/WMSLayer.js, line 542

加载图层资源

Example

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

// 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)
})

inherited refresh()

document/layer/baseLayer/Layer.js, line 747

刷新图层

inherited setProperty(path, value){Boolean}

document/layer/baseLayer/Layer.js, line 778

设置属性值或者属性路径对应的值。由于当前仅支持第一级属性响应，无法解决多级属性响应机制，此方法支持属性路径响应机制。例如:path输入'tileInfo.startLevel',则会响应式更新startLevel。

Name	Type	Description
path	String	属性路径，可以传入单个属性后者一个属性的路径
value	*

Returns:

Type	Description
Boolean	是否设置成功

toJSON(){Object}

document/layer/ogc/WMSLayer.js, line 823

转换为json对象

Returns:

Type	Description
Object	json对象