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

所有子图层对象信息

autoAddTo2DBoolean

是否自动添加到二维引擎的地图对象。

该属性主要用于部分第三方引擎：图层的加载与添加由应用侧自行控制，而不是框架自动添加。

Default Value:

true

Events

inherited layer-update

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

图层属性更新事件。

当调用 refresh()、setProperty() 或图层内部主动触发更新时，会向 Map/View 分发该事件。 该事件主要用于渲染层同步图层状态。

Properties:

Name	Type	Description
event	LayerViewUpdateEvent	事件对象 Properties Name Type Default Description type String 'layer-update' 可选 事件类型 layer Layer 可选 图层对象 updateContent Array.<Object> 可选 更新详情

Example

Create Layer instance

// ES5 import style
const { Layer } = zondy

// ES6 import style
import { Layer } from '@mapgis/webclient-common'

inherited layerview-created

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

图层在视图中创建完毕事件。

当图层被添加到 View，并且该引擎对应的图层视图对象创建成功后触发。

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-created' 可选 事件类型 message String null 可选 描述信息 layer Layer null 可选 图层对象 layerView * null 可选 图层视图对象（不同引擎类型不同） sourceTarget * null 可选 事件发起对象 target * null 可选 事件接收对象（通常为 View/Map）

Example

layer.on('layerview-created', (event) => {
  console.log('图层视图创建完毕', event.layer, event.layerView)
})

inherited layerview-remove

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

图层从视图中移除事件。

当图层从 View 移除，并且对应的图层视图对象已释放后触发。

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-remove' 可选 事件类型 message String null 可选 描述信息 layer Layer null 可选 图层对象 layerView * null 可选 图层视图对象 sourceTarget * null 可选 事件发起对象 target * null 可选 事件接收对象（通常为 View/Map）

Example

layer.on('layerview-remove', (event) => {
  console.log('图层视图已移除', event.layer)
})

inherited layerview-scale-visible

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

图层比例尺显示/隐藏状态更新事件。

该事件由 View 层在比例尺变化导致图层显示状态（因 minScale/maxScale 约束）变化时触发。 当前仅支持非组图层以及场景子图层。

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-scale-visible' 可选 事件类型 target * 可选 事件接收对象 sourceTarget * 可选 事件发起对象

Example

layer.on('layerview-scale-visible', (event) => {
  console.log('比例尺可见性变更', event)
})

inherited layerview-update

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

图层视图更新事件。

该事件通常由 View 层触发，用于通知外部“渲染层已完成一次图层更新”。 event.updateContent 中会描述本次更新涉及的属性或方法（例如：visible、opacity、refresh）。

Properties:

Name	Type	Description
event	LayerViewUpdateEvent	事件对象 Properties Name Type Description updateContent Array.<Object> 可选 更新详情数组

Example

layer.on('layerview-update', (event) => {
  const updateContent = event.updateContent || []
  const hasVisibleChange = updateContent.some((c) => c.name === 'visible')
  const hasOpacityChange = updateContent.some((c) => c.name === 'opacity')
  const hasRefresh = updateContent.some((c) => c.name === 'refresh')
  console.log('更新完毕', { hasVisibleChange, hasOpacityChange, hasRefresh })
})

子图层显隐更新完毕事件

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

子图层显隐更新完毕事件，请注意该事件是图层更新事件(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

clone(){WMSLayer}

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

克隆WMSLayer对象

Returns:

Type	Description
WMSLayer	克隆后的WMSLayer实例

inherited destroy(){void}

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

销毁图层。

基类不做具体释放逻辑，子类可根据需要重写（例如：释放请求、解绑引擎对象等）。

Returns:

Type	Description
void

findSublayerById(sublayerID){WMSSubLayer|null}

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

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

获取属性或属性路径对应的值。

Name	Type	Description
path	String	属性路径

Returns:

Type	Description
*	属性值

inherited isLoaded(){Boolean}

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

判断图层是否加载成功

Returns:

Type	Description
Boolean	图层是否加载成功

load()

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

加载图层资源

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(){void}

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

刷新图层。

该方法会触发 layer-update 事件（若图层已添加到地图且已加载），用于通知渲染层重新拉取/绘制。

Returns:

Type	Description
void

inherited setMap(map){void}

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

设置图层所属的地图/场景管理容器。

该方法通常由 Map 在添加图层时调用，外部一般无需手动调用。

Name	Type	Description
map	*	地图/场景管理对象（不同引擎类型不同）

Returns:

Type	Description
void

inherited setProperty(path, value){Boolean}

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

设置属性值或属性路径对应的值。

由于默认仅支持第一级属性响应，此方法提供“属性路径”写入能力。 例如：setProperty('tileInfo.startLevel', 3) 可更新 tileInfo.startLevel。

若设置的是多级属性路径，会额外触发一次 layer-update 事件（updateContent.name 为路径字符串）。

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

Returns:

Type	Description
Boolean	是否设置成功

toJSON(){Object}

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

转换为 JSON 对象

Returns:

Type	Description
Object	JSON 对象

WMSLayer.fromJSON(json){WMSLayer}

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

通过 JSON 构造 WMSLayer 对象

Name	Type	Description
json	Object	JSON 对象

Returns:

Type	Description
WMSLayer	WMSLayer实例

WMSLayer.fromServerUrl(url){WMSLayer}

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

通过url创建图层对象

Name	Type	Description
url	String	服务基地址

Returns:

Type	Description
WMSLayer	新的图层对象