MapGIS Client for JavaScript API

# allSublayers

# clippingArea

# readonly copyright

Inherited From:

• Layer#copyright

# customParameters

Inherited From:

• OGCLayer#customParameters

# readonly description

Inherited From:

• Layer#description

# extendProps

Inherited From:

• Layer#extendProps

Default Value:

• {}

# extensionOptions

Inherited From:

• Layer#extensionOptions

Default Value:

• {}

# readonly extent

Inherited From:

• Layer#extent

# headers

Inherited From:

• Layer#headers

# httpMethod

Inherited From:

• Layer#httpMethod

# readonly id

Inherited From:

• Layer#id

# imageFormat

# readonly imageFormats

# imageHeight

# imageTransparency

# imageWidth

# index

Inherited From:

• Layer#index

# readonly layers

# readonly loaded

Inherited From:

• Layer#loaded

Default Value:

• false

# readonly loadStatus

Inherited From:

• Layer#loadStatus

Default Value:

• not-loaded

# maxScale

Inherited From:

• Layer#maxScale

Default Value:

• 0

# minScale

Inherited From:

• Layer#minScale

Default Value:

• 0

# opacity

Inherited From:

• Layer#opacity

# spatialReference

Overrides:

• OGCLayer#spatialReference

# spatialReferences

# sublayers

# sublayers

# title

Inherited From:

• Layer#title

# tokenAttachType

Inherited From:

• Layer#tokenAttachType

# tokenKey

Inherited From:

• Layer#tokenKey

Default Value:

• token

# tokenValue

Inherited From:

• Layer#tokenValue

# readonly type

Overrides:

• OGCLayer#type

# readonly url

# readonly version

Overrides:

• OGCLayer#version

# visible

Inherited From:

• Layer#visible

# static fromJSON(jsonopt)

参数:

示例

通过传入的json构造并返回一个新的几何对象

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

# static fromServerUrl(url)

参数:

# clone()

Inherited From:

• Layer#clone

# destroy()

Inherited From:

• Layer#destroy

# findSublayerById(sublayerID)

参数:

示例

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

• Layer#isLoaded

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

# refresh()

Inherited From:

• Layer#refresh

# setSubLayer(wmsSublayer)

参数:

示例

设置子图层参数

// 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);
// 通过setSubLayer方法设置子图层显隐
// 通过图层id来设置显隐
wmsLayer.setSubLayer({
  id: 0,
  visible: false
})
// 或者通过图层名称设置显隐
wmsLayer.setSubLayer({
  name: "Map_Hubei4326:t1",
  visible: true
})

# toJSON()

Overrides:

• OGCLayer#toJSON

# 图层刷新完毕事件

属性:

Inherited From:

• Layer#event:图层刷新完毕事件

示例

图层刷新完毕事件

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 From:

• Layer#event:图层加载完毕事件

示例

图层加载完毕事件

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

# 图层显隐更新完毕事件

属性:

Inherited From:

• Layer#event:图层显隐更新完毕事件

示例

图层显隐更新完毕事件

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 From:

• Layer#event:图层更新完毕事件

示例

图层更新完毕事件

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

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

属性:

Inherited From:

• Layer#event:图层透明度更新完毕事件

示例

图层透明度更新完毕事件

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 From:

• Layer#event:图层销毁完毕事件

示例

图层销毁完毕事件

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

# 图层顺序更新完毕事件

属性:

Inherited From:

• Layer#event:图层顺序更新完毕事件

示例

图层顺序更新完毕事件

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 === 'index'){
      console.log("图层顺序更新完毕事件:", event);
    }
  }
});

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

属性:

示例

子图层显隐更新完毕事件

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