Class: Layer

Extends

• Evented

Members

capabilitiesObject

图层支持能力。图层支持能力分为客户端能力和服务端能力，其中客户端能力包含cesium、leaflet、mapboxgl引擎能力。默认图层客户端能力：所有引擎支持图层加载；默认图层服务端能力为空。

copyrightString

版权所有

descriptionString

图层描述

extendPropsObject

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

Default Value:

{}

Events

图层加载完毕事件

document/layer/baseLayer/Layer.js, line 46

图层加载完毕事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-created' 可选 图层加载完毕事件 message String null 可选 更新描述 UpdateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层加载完毕事件

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

图层显隐更新完毕事件

document/layer/baseLayer/Layer.js, line 90

图层显隐更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层显隐更新完毕事件

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

图层比例尺显示隐藏状态更新事件。当前仅支持非组图层以及场景子图层

document/layer/baseLayer/Layer.js, line 144

图层刷新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象
event	LayerViewScaleVisibleEvent	事件对象 layer.on('layerview-scale-visible', (event) => { console.log("图层比例尺显示隐藏状态更新事件:", event) })

Example

图层刷新完毕事件

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

/**

图层视图更新事件

document/layer/baseLayer/Layer.js, line 80

图层视图更新事件

Properties:

Name	Type	Description
event	LayerViewUpdateEvent	事件对象

Example

图层更新完毕事件

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

图层透明度更新完毕事件

document/layer/baseLayer/Layer.js, line 117

图层透明度更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-update' 可选 图层更新完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层透明度更新完毕事件

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

图层销毁完毕事件

document/layer/baseLayer/Layer.js, line 63

图层销毁完毕事件

Properties:

Name	Type	Description
event	Object	事件对象 Properties Name Type Default Description type String 'layerview-remove' 可选 图层销毁完毕事件 message String null 可选 更新描述 updateContent Array.<UpdateContent> null 可选 更新详情对象 layer Layer null 可选 要销毁的地图图层对象 layerView MapView null 可选 图层的视图对象 sourceTarget Layer null 可选 事件发起对象 target Map null 可选 事件接收对象

Example

图层销毁完毕事件

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

Methods

Layer.fromJSON(json){*}

document/layer/baseLayer/Layer.js, line 682

Name	Type	Description
json	*

Returns:

Type	Description
*

Layer.fromServerUrl(url, options){Promise.<Layer>}

document/layer/baseLayer/Layer.js, line 669

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

Name	Type	Description
url	String	服务地址
options	Object	图层配置

Returns:

Type	Description
Promise.<Layer>	从url中加载图层

Layer.load(){Promise.<Layer>}

document/layer/baseLayer/Layer.js, line 547

图层资源加载

Returns:

Type	Description
Promise.<Layer>	资源加载完毕的图层

clone(){Layer}

document/layer/baseLayer/Layer.js, line 659

克隆方法

Returns:

Type	Description
Layer	图层

destroy(){*}

document/layer/baseLayer/Layer.js, line 618

Returns:

Type	Description
*

getProperty(path){*}

document/layer/baseLayer/Layer.js, line 818

获取属性

Name	Type	Description
path	String

Returns:

Type	Description
*	属性值

isLoaded(){Boolean}

document/layer/baseLayer/Layer.js, line 543

判断图层是否加载成功

Returns:

Type	Description
Boolean	图层是否加载成功

inherited off(types, fn, context){Object}

base/Evented.js, line 328

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

Name	Type	Description
types	string	可选 移除指定事件类型上绑定的回调函数 当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"； 当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn	function	可选 事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
context	Object	可选 事件回调函数的this关键字将指向的对象

Returns:

Type	Description
Object	当前实例

Examples

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

// 一个事件的回调函数
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)

inherited on(types, fn, context){Object}

base/Evented.js, line 232

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

Name	Type	Default	Description
types	String | Object	null	可选 事件类型 当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"； 当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn	function	null	可选 事件回调函数
context	Object	null	可选 事件回调函数的this关键字将指向的对象

Returns:

Type	Description
Object	当前实例

Examples

注册一个事件

// 初始化一个点击事件回调函数
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()

document/layer/baseLayer/Layer.js, line 747

刷新图层

setProperty(path, value){Boolean}

document/layer/baseLayer/Layer.js, line 778

设置属性值或者属性路径对应的值。由于当前仅支持第一级属性响应，无法解决多级属性响应机制，此方法支持属性路径响应机制。例如:path输入'tileInfo.startLevel',则会响应式更新startLevel。

Name	Type	Description
path	String	属性路径，可以传入单个属性后者一个属性的路径
value	*

Returns:

Type	Description
Boolean	是否设置成功

toJSON(){Object}

document/layer/baseLayer/Layer.js, line 624

转换为json对象

Returns:

Type	Description
Object	json对象