MapGIS Client for JavaScript API

# readonly copyright

Inherited From:

• Layer#copyright

# readonly description

Inherited From:

• Layer#description

# elevationInfo

# extendProps

Inherited From:

• Layer#extendProps

Default Value:

• {}

# extensionOptions

Inherited From:

• Layer#extensionOptions

Default Value:

• {}

# readonly extent

Inherited From:

• Layer#extent

# graphics

# headers

Inherited From:

• Layer#headers

# httpMethod

Inherited From:

• Layer#httpMethod

# readonly id

Inherited From:

• Layer#id

# index

Inherited From:

• Layer#index

# readonly loaded

Overrides:

• Layer#loaded

Default Value:

• false

# readonly loadStatus

Overrides:

• Layer#loadStatus

Default Value:

• not-loaded

# maxScale

Overrides:

• Layer#maxScale

# minScale

Overrides:

• Layer#minScale

# opacity

Inherited From:

• Layer#opacity

# spatialReference

Inherited From:

• Layer#spatialReference

# title

Inherited From:

• Layer#title

# tokenAttachType

Inherited From:

• Layer#tokenAttachType

# tokenKey

Overrides:

• Layer#tokenKey

# tokenValue

Overrides:

• Layer#tokenValue

# readonly type

Overrides:

• Layer#type

# visible

Inherited From:

• Layer#visible

# static fromJSON(jsonopt)

参数:

示例

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

// ES5引入方式
const { Feature } = zondy
const { Circle } = zondy.geometry
const { GraphicsLayer } = zondy.layer
// ES6引入方式
import {  Feature,Circle,GraphicsLayer } from "@mapgis/webclient-common"
// 创建一个要素
const feature1 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [113, 30],
    // 半径
    radius: 4
  })
})
const feature2 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [123, 33],
    // 半径
    radius: 4
  })
})
const json = {
  graphics: [feature1, feature2]
}
// 创建图层
const graphicsLayer = new GraphicsLayer.fromJSON(json)

# add(feature)

参数:

# addMany(features)

参数:

示例

添加要素组

// ES5引入方式
const { Feature } = zondy
const { Circle } = zondy.geometry
const { GraphicsLayer } = zondy.layer
// ES6引入方式
import {  Feature,Circle,GraphicsLayer } from "@mapgis/webclient-common"
// 创建一个要素
const feature1 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [113, 30],
    // 半径
    radius: 4
  })
})
const feature2 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [123, 33],
    // 半径
    radius: 4
  })
})
// 创建图层
const graphicsLayer = new GraphicsLayer()
map.add(graphicsLayer)
// 一次添加多个要素
graphicsLayer.addMany([feature1, feature2])

# clone()

Inherited From:

• Layer#clone

# destroy()

Inherited From:

• Layer#destroy

# isLoaded()

Inherited From:

• Layer#isLoaded

# refresh()

Inherited From:

• Layer#refresh

# remove(feature)

参数:

示例

删除要素

// ES5引入方式
const { Feature,Color } = zondy
const { Circle } = zondy.geometry
const { GraphicsLayer } = zondy.layer
const { SimpleFillSymbol } = zondy.symbol
// ES6引入方式
import {  Feature,Color,Circle,GraphicsLayer,SimpleFillSymbol } from "@mapgis/webclient-common"
// 创建一个要素
const feature = new Feature({
  //不填则创建一个随机的guid
  id: '你的id',
  //设置属性
  attributes: {},
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [113, 30],
    // 半径
    radius: 4
  }),
  //设置样式
  symbol: new SimpleFillSymbol({
    //设置颜色
    color: new Color(255, 0, 112, 1)
  })
})
// 创建图层
const graphicsLayer = new GraphicsLayer()
graphicsLayer.add(feature)
map.add(graphicsLayer)
// 删除要素
graphicsLayer.remove(feature)

# removeAll()

示例

删除全部要素

// ES5引入方式
const { Feature } = zondy
const { Circle } = zondy.geometry
const { GraphicsLayer } = zondy.layer
// ES6引入方式
import {  Feature,Color,Circle,GraphicsLayer } from "@mapgis/webclient-common"
// 创建一个要素
const feature1 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [113, 30],
    // 半径
    radius: 4
  })
})
const feature2 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [123, 33],
    // 半径
    radius: 4
  })
})
// 创建图层
const graphicsLayer = new GraphicsLayer({
  graphics: [feature1, feature2]
})
map.add(graphicsLayer)
// 删除全部要素
graphicsLayer.removeAll()

# removeMany(features)

参数:

示例

删除要素组

// ES5引入方式
const { Feature } = zondy
const { Circle } = zondy.geometry
const { GraphicsLayer } = zondy.layer
// ES6引入方式
import {  Feature,Circle,GraphicsLayer } from "@mapgis/webclient-common"
// 创建一个要素
const feature1 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [113, 30],
    // 半径
    radius: 4
  })
})
const feature2 = new Feature({
  //构建几何
  geometry: new Circle({
    // 中心点
    center: [123, 33],
    // 半径
    radius: 4
  })
})
// 创建图层
const graphicsLayer = new GraphicsLayer({
  graphics: [feature1, feature2]
})
map.add(graphicsLayer)
// 一次删除多个要素
graphicsLayer.removeMany([feature1, feature2])

# toJSON()

Overrides:

• Layer#toJSON

# 删除多个要素事件

属性:

示例

子图层显隐更新完毕事件

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 === 'removeMany'){
      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 === 'removeAll'){
      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 === 'remove'){
      console.log("删除要素事件:", event);
    }
  }
});

# 图层刷新完毕事件

属性:

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 === 'addMany'){
      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 === 'add'){
      console.log("添加要素事件:", event);
    }
  }
});