#### # new Layer(options)

图层基类

#### 参数:

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`options` | Object |  | 构造参数
`title` | String |  | 图层名称
`spatialReference` | SpatialReference |  | 图层坐标系
`minScale` | Number | 0 | 最小缩放级数，仅会请求级数大于等于minScale的图片
`maxScale` | Number | 19 | 最大缩放级数，仅会请求级数小于等于maxScale的图片
`tokenKey` | String | 'token' | token名
`tokenValue` | String |  | token值，只有当tokenValue存在时，才会绑定token
`extendProps` | Object |  | 存储额外参数的属性

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

绑定事件:

- Layer#event:图层加载完毕事件
- Layer#event:图层销毁完毕事件
- Layer#event:图层更新完毕事件
- Layer#event:图层显隐更新完毕事件
- Layer#event:图层透明度更新完毕事件
- Layer#event:图层顺序更新完毕事件
- Layer#event:图层刷新完毕事件

### 继承关系

- Evented

### 成员变量

类型: String

#### # readonly copyright

版权所有

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

类型: String

#### # readonly description

图层描述

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

类型: Object

#### # extendProps

存储额外参数的属性

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

类型: Extent

#### # readonly extent

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

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

类型: String

#### # httpMethod

http请求方式

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

类型: String

#### # readonly id

图层id

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

类型: Number

#### # index

图层顺序

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

类型: Boolean

#### # readonly loaded

是否加载完毕

Default Value:
  - false

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

类型: String

#### # readonly loadStatus

图层加载状态

Default Value:
  - not-loaded

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

类型: Number

#### # maxScale

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

Default Value:
  - 19

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

类型: Number

#### # minScale

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

Default Value:
  - 0

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

类型: Number

#### # opacity

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

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

类型: SpatialReference

#### # spatialReference

图层坐标系对象

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

类型: SpatialReference

#### # spatialReference

图层坐标系对象

查看源代码 common/document/layer/baseLayer/MapImageLayer.js, line 172

类型: SpatialReference

#### # spatialReference

图层坐标系对象

查看源代码 common/document/layer/ogc/WMSLayer.js, line 765

类型: String

#### # title

图层名称

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

类型: String

#### # tokenKey

token名

Default Value:
  - token

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

类型: String

#### # tokenValue

token值

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

类型: String

#### # readonly type

图层类型

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

类型: Number

#### # visible

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

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

### 方法

#### # static fromServerUrl(url, options)

根据服务url加载图层(通过判断url链接获取图层,等图层全部封装完毕后处理此函数)

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`url` | String | 服务地址
`options` | Object | 图层配置

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

返回值:

从url中加载图层

类型: Promise.<Layer>

#### # static load()

图层资源加载

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

返回值:

资源加载完毕的图层

类型: Promise.<Layer>

#### # clone()

克隆方法

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

返回值:

图层

类型: Layer

#### # isLoaded()

判断图层是否加载成功

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

返回值:

图层是否加载成功

类型: Boolean

#### # 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:
  - Evented#off

查看源代码 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:
  - Evented#on

查看源代码 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()

刷新图层

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

#### # toJSON()

转换为json对象

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

返回值:

json对象

类型: 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 | 事件接收对象

查看源代码 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 | 事件接收对象

查看源代码 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 | 事件接收对象

查看源代码 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 | 事件接收对象

查看源代码 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 | 事件接收对象

查看源代码 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 | 事件接收对象

查看源代码 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 | 事件接收对象

查看源代码 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);
        }
      }
    });