Cesium MapboxGL Leaflet OpenLayers
API文档
类名 GroupLayer

# new GroupLayer(options)

组图层，支持的图层类型有：WMS图层、WMTS图层、地图图层、瓦片图层、cesium3DTiles图层、echarts图层、 M3D图层、场景图层、矢量瓦片图层、mapv图层、地形图层

[ES5引入方式]：
Zondy.Layer.GroupLayer()
[ES6引入方式]：
import { GroupLayer } from "@mapgis/webclient-common"

参数:

名称 类型 默认值 描述
options Object

构造参数
layers Array []

子图层数组
visible Boolean true

图层可见性
opacity Number 1

图层透明度，0到1之间的数字

查看源代码 common/document/layer/GroupLayer.js, line 6

示例

组图层示例

// 初始化图层管理容器
// ES5引入方式
const { Map ,SceneView } = Zondy
const { IGSMapImageLayer,WMTSLayer,GroupLayer } = Zondy.Layer
// ES6引入方式
import { Map ,SceneView, IGSMapImageLayer,WMTSLayer,GroupLayer} from "@mapgis/webclient-common"
const map = new Map();
// 初始化地图视图对象
const sceneView = new SceneView({
  // 视图id
  viewId: "mapgis-3d-viewer",
  // 图层管理容器
  map: map
});
// 创建一个矢量图层
const igsMapImageLayer = new IGSMapImageLayer({
  url: 'http://192.168.82.89:8089/igs/rest/services/Map/WorldJWVector/MapServer'
});
// 创建一个WMS图层
const wmsLayer = new WMTSLayer({
  url: 'http://192.168.82.89:8089/igs/rest/services/Tile/北京市/WMTSServer'
});
// 创建一个组图层
const groupLayer = new GroupLayer({
  // 添加子图层
  layers: [igsMapImageLayer, wmsLayer]
})
// 添加组图层
map.add(groupLayer);

继承关系

成员变量

Array

# allLayers

所有子图层数组

查看源代码 common/document/layer/GroupLayer.js, line 68

String

版权所有

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 210

String

# readonly description

图层描述

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 204

Object

# extendProps

存储额外参数的属性

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 264

Extent

# readonly extent

图层范围，从服务元信息中获取

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 499

String

# httpMethod

http请求方式

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 275

String

# readonly id

图层id

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 198

Number

# index

图层顺序

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 242

Array

# layers

子图层数组

查看源代码 common/document/layer/GroupLayer.js, line 63

Boolean

# readonly loaded

是否加载完毕

Inherited From:
Default Value:
  • false

查看源代码 common/document/layer/baseLayer/Layer.js, line 223

String

# readonly loadStatus

图层加载状态

Inherited From:
Default Value:
  • not-loaded

查看源代码 common/document/layer/baseLayer/Layer.js, line 216

Number

# maxScale

最大缩放级数，仅会请求级数小于等于maxScale的图片

Inherited From:
Default Value:
  • 19

查看源代码 common/document/layer/baseLayer/Layer.js, line 258

Number

# minScale

最小缩放级数，仅会请求级数大于等于minScale的图片

Inherited From:
Default Value:
  • 0

查看源代码 common/document/layer/baseLayer/Layer.js, line 252

Number

# opacity

图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 465

SpatialReference

# spatialReference

图层坐标系对象

Overrides:

查看源代码 common/document/layer/baseLayer/Layer.js, line 486

String

# title

图层名称

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 247

String

# tokenKey

token名

Inherited From:
Default Value:
  • token

查看源代码 common/document/layer/baseLayer/Layer.js, line 231

String

# tokenValue

token值

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 237

String

# readonly type

图层类型

Overrides:

查看源代码 common/document/layer/baseLayer/Layer.js, line 269

String

# url

图层类型

查看源代码 common/document/layer/GroupLayer.js, line 57

Number

# visible

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

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 444

方法

# add(layer)

添加子图层

参数:

名称 类型 描述
layer Object

图层对象

查看源代码 common/document/layer/GroupLayer.js, line 127

# clone()

克隆并返回一个新图层

Overrides:

查看源代码 common/document/layer/GroupLayer.js, line 200

新的组图层对象

GroupLayer

# findLayerById(layerId)

通过图层id获取子图层

参数:

名称 类型 描述
layerId String

子图层id

查看源代码 common/document/layer/GroupLayer.js, line 159

子图层对象

Layer

# getFlatLayers()

获取组图层中的所有子图层数组

查看源代码 common/document/layer/GroupLayer.js, line 144

所有子图层数组

Array

# isLoaded()

判断图层是否加载成功

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 301

图层是否加载成功

Boolean

# load()

从igs获取图层信息的方法

查看源代码 common/document/layer/GroupLayer.js, line 78

# off(typesopt, fnopt, contextopt)

移除事件
示例如下:
[1、移除一个事件的指定回调函数]
[2、移除一个事件的所有回调函数]
[3、移除多个事件的同一个指定的回调函数]
[4、移除多个指定事件的回调函数]
[5、删除时指定上下文 - types类型为字符串]
[6、删除时指定上下文 - types类型为对象]

参数:

名称 类型 描述
types string

移除指定事件类型上绑定的回调函数
当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function

事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
context Object

事件回调函数的this关键字将指向的对象
Inherited From:

查看源代码 common/base/Evented.js, line 269

当前实例

Object
示例

移除一个事件的指定回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction)

移除一个事件的所有回调函数

// 一个事件的回调函数1
const clickFunction1 = function (event) {
  console.log("点击事件1:", event)
}

// 一个事件的回调函数2
const clickFunction2 = function (event) {
  console.log("点击事件2:", event)
}

// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
// 不指定回调函数，则移除该事件上的所有绑定的回调函数
view.off('click')

移除多个事件的同一个指定的回调函数

// 多个事件的同一个回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}
// 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数
view.off('click double-click', eventFunction)

移除多个指定事件的回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
})

删除时指定上下文 - types类型为字符串

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction, view)
// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
view.off('click', undefined, view)

删除时指定上下文 - types类型为对象

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
}, view)

# on(typesopt, fnopt, contextopt)

注册一个新的监听事件;
示例如下：
[1、注册一个事件]
[2、一次注册多个事件 - 同一个回调函数]
[3、一次注册多个事件 - 分别指回调应函数]
[4、当types为字符串时 - 指定上下文]
[5、当types为对象时 - 指定上下文]

参数:

名称 类型 默认值 描述
types String | Object null

事件类型
当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"；
当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn function null

事件回调函数
context Object null

事件回调函数的this关键字将指向的对象
Inherited From:

查看源代码 common/base/Evented.js, line 173

当前实例

Object
示例

注册一个事件

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)

一次注册多个事件 - 同一个回调函数

// 初始化一个事件回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)

一次注册多个事件 - 分别指回调应函数

// 初始化一个左键点击事件回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}

// 初始化一个右键按下事件回调函数
const rightClickFunction = function (event) {
  console.log("right-click-down事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 每一个事件类型，使用单独的回调函数
// 注意使用此种方式，一种类型的事件仅能指定一个回调函数
view.on({
  "click": clickFunction,
  "right-click-down": rightClickFunction
})

指定上下文 - types类型为字符串

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)

指定上下文 - types类型为对象

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
  "click": clickFunction,
  "right-click-down": clickFunction
}, view)

# refresh()

刷新图层

Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 416

# remove(layer)

删除子图层

参数:

名称 类型 描述
layer Object

图层对象

查看源代码 common/document/layer/GroupLayer.js, line 106

# removeAll()

移除所有子图层

查看源代码 common/document/layer/GroupLayer.js, line 173

# toJSON()

将图层转为json对象

Overrides:

查看源代码 common/document/layer/GroupLayer.js, line 190

josn对象

Object

事件

# 图层刷新完毕事件

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

查看源代码 common/document/layer/baseLayer/Layer.js, line 167

示例

图层刷新完毕事件

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

# 图层加载完毕事件

图层加载完毕事件

属性:
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:

查看源代码 common/document/layer/baseLayer/Layer.js, line 35

示例

图层加载完毕事件

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:

查看源代码 common/document/layer/baseLayer/Layer.js, line 86

示例

图层显隐更新完毕事件

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:

查看源代码 common/document/layer/baseLayer/Layer.js, line 69

示例

图层更新完毕事件

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

事件接收对象
Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 113

示例

图层透明度更新完毕事件

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:

查看源代码 common/document/layer/baseLayer/Layer.js, line 52

示例

图层销毁完毕事件

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

事件接收对象
Inherited From:

查看源代码 common/document/layer/baseLayer/Layer.js, line 140

示例

图层顺序更新完毕事件

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);
    }
  }
});
构造函数
成员变量
方法
事件