#### # new GroupLayer(options)

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

#### 参数

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`options` | Object |  | 构造参数
`layers` | Array | [] | 子图层数组
`visible` | Boolean | true | 图层可见性
`opacity` | Number | 1 | 图层透明度，0到1之间的数字

##### 示例

<h7>组图层示例</h7>

    // 初始化图层管理容器
    // ES5引入方式
    const { IGSMapImageLayer,WMTSLayer,GroupLayer } = zondy.layer
    // ES6引入方式
    import { IGSMapImageLayer,WMTSLayer,GroupLayer} from "@mapgis/webclient-common"
    // 创建一个矢量图层
    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]
    })

### 继承关系

- Layer

### 成员变量

#### 成员变量概述

名称 | 类型 | 描述
--- | --- | ---
`allLayers` | `Collection.<Layer>` | `子图层扁平后容器`
`copyright` | `String` | `版权所有`
`description` | `String` | `图层描述`
`extendOptions` | `Object` | `初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数`
`extendProps` | `Object` | `当前图层对象上不支持的属性，二次开发用户希望挂在图层对像上的属性可以存储到该属性中`
`extent` | `Extent` | `图层范围，从服务元信息中获取`
`headers` | `String` | `设置服务请求头`
`httpMethod` | `FetchMethod` | `http请求方式`
`id` | `String` | `图层id`
`index` | `Number` | `图层顺序`
`layers` | `Collection.<Layer>` | `子图层数组`
`loaded` | `Boolean` | `是否加载完毕`
`loadStatus` | `String` | `图层加载状态`
`maxScale` | `Number` | `最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。`
`minScale` | `Number` | `最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。`
`opacity` | `Number` | `图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。`
`spatialReference` | `SpatialReference` | `图层坐标系对象`
`title` | `String` | `图层名称`
`tokenAttachType` | `String` | `token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾`
`tokenKey` | `String` | `token名`
`tokenValue` | `String` | `token值`
`type` | `String` | `图层类型`
`url` | `String` | `图层类型`
`visible` | `Number` | `图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件`

#### 成员变量详情

类型: Collection.<Layer>

#### # readonly allLayers

子图层扁平后容器

类型: String

#### # readonly copyright

版权所有

Inherited From:
  - Layer#copyright

类型: String

#### # readonly description

图层描述

Inherited From:
  - Layer#description

类型: Object

#### # extendOptions

初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数

Inherited From:
  - Layer#extendOptions
Default Value:
  - {}

类型: Object

#### # extendProps

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

Inherited From:
  - Layer#extendProps
Default Value:
  - {}

类型: Extent

#### # readonly extent

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

Inherited From:
  - Layer#extent

类型: String

#### # headers

设置服务请求头

Inherited From:
  - Layer#headers

类型: FetchMethod

#### # httpMethod

http请求方式

Inherited From:
  - Layer#httpMethod

类型: String

#### # readonly id

图层id

Inherited From:
  - Layer#id

类型: Number

#### # index

图层顺序

Inherited From:
  - Layer#index

类型: Collection.<Layer>

#### # layers

子图层数组

类型: Boolean

#### # readonly loaded

是否加载完毕

Overrides:
  - Layer#loaded
Default Value:
  - false

类型: String

#### # readonly loadStatus

图层加载状态

Overrides:
  - Layer#loadStatus
Default Value:
  - not-loaded

类型: Number

#### # maxScale

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。

Inherited From:
  - Layer#maxScale
Default Value:
  - 0

类型: Number

#### # minScale

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。

Inherited From:
  - Layer#minScale
Default Value:
  - 0

类型: Number

#### # opacity

图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。

Inherited From:
  - Layer#opacity

类型: SpatialReference

#### # spatialReference

图层坐标系对象

Overrides:
  - Layer#spatialReference

类型: String

#### # title

图层名称

Inherited From:
  - Layer#title

类型: String

#### # tokenAttachType

token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾

Inherited From:
  - Layer#tokenAttachType

类型: String

#### # tokenKey

token名

Inherited From:
  - Layer#tokenKey
Default Value:
  - token

类型: String

#### # tokenValue

token值

Inherited From:
  - Layer#tokenValue

类型: String

#### # readonly type

图层类型

Overrides:
  - Layer#type

类型: String

#### # url

图层类型

类型: Number

#### # visible

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

Inherited From:
  - Layer#visible

### 方法

#### 方法概述

名称 | 返回值类型 | 描述
--- | --- | ---
`fromJSON` | `GroupLayer` | ``
`add` | `*` | ``
`addMany` | `*` | ``
`clone` | `GroupLayer` | `克隆并返回一个新图层`
`destroy` | `*` | ``
`findLayerById` | `Layer | null` | `通过图层id获取子图层`
`getFlatLayers` | `Array` | `获取组图层中的所有子图层数组`
`isLoaded` | `Boolean` | `判断图层是否加载成功`
`load` | `` | `从igs获取图层信息的方法`
`refresh` | `` | `刷新图层`
`remove` | `` | `删除子图层`
`removeAll` | `` | `移除所有子图层`
`removeMany` | `*` | ``
`reorder` | `` | `调整图层顺序`
`setMap` | `*` | ``
`toJSON` | `Object` | `将图层转为json对象`

#### 方法详情

#### # static fromJSON(json)

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`json` | * |

返回值
类型: GroupLayer

#### # add(layer, index)

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`layer` | Layer | 图层
`index` | Number | 图层在列表内的下标值

返回值
类型: *

#### # addMany(layers, index)

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`layers` | Array.<Layer> |
`index` | * |

返回值
类型: *

#### # clone()

克隆并返回一个新图层

Overrides:
  - Layer#clone

返回值

新的组图层对象

类型: GroupLayer

#### # destroy()

Overrides:
  - Layer#destroy

返回值
类型: *

#### # findLayerById(layerId)

通过图层id获取子图层

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`layerId` | String | 子图层id

返回值

子图层对象

类型: Layer | null

#### # getFlatLayers()

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

返回值

所有子图层数组

类型: Array

#### # isLoaded()

判断图层是否加载成功

Overrides:
  - Layer#isLoaded

返回值

图层是否加载成功

类型: Boolean

#### # load()

从igs获取图层信息的方法

#### # refresh()

刷新图层

Inherited From:
  - Layer#refresh

#### # remove(layer)

删除子图层

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`layer` | Layer | 图层对象

#### # removeAll()

移除所有子图层

#### # removeMany(layers)

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`layers` | Array.<Layer> |

返回值
类型: *

#### # reorder(layer, index)

调整图层顺序

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`layer` | Layer | 要调整顺序的图层
`index` | Number | 图层列表的下标值

##### 示例

    layer.reorder(layer, '要移动到的index');

#### # setMap(map)

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`map` | * |

返回值
类型: *

#### # toJSON()

将图层转为json对象

Overrides:
  - Layer#toJSON

返回值

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

#### # 图层加载完毕事件

图层加载完毕事件

##### 属性:

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:
  - Layer#event:图层加载完毕事件

##### 示例

<h7>图层加载完毕事件</h7>

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

#### # 图层更新完毕事件

图层更新完毕事件

##### 属性:

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:
  - Layer#event:图层更新完毕事件

##### 示例

<h7>图层更新完毕事件</h7>

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

#### # 图层销毁完毕事件

图层销毁完毕事件

##### 属性:

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:
  - Layer#event:图层销毁完毕事件

##### 示例

<h7>图层销毁完毕事件</h7>

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