Class: LayerView

// ES5 import style
const { LayerView } = zondy

// ES6 import style
import { LayerView } from '@mapgis/webclient-common'

Extends

• Evented

Members

innerViewObject null

当前图层视图所属的引擎内部视图对象。

该属性等价于 view.getInnerView() 的快捷访问方式，常用于子类在实现底层引擎交互时直接读取内部视图。

Methods

_fireLayerViewUpdateEvent(message, updateContent){*}

view/LayerView.js, line 219

发送视图更新事件

Name	Type	Description
message	String
updateContent	UpdateContent | Array.<UpdateContent>

Returns:

Type	Description
*

_updateScaleVisible(){*}

view/LayerView.js, line 100

更新比例尺可见性

Returns:

Type	Description
*

checkLayerCanAddedStatus(){Boolean}

view/LayerView.js, line 183

检查当前图层视图是否仍然允许被添加到视图中。

在异步创建图层视图的过程中，如果图层已经从父容器移除， 或所属视图已经被销毁，则应放弃继续执行添加逻辑。

Returns:

Type	Description
Boolean	true 表示图层仍存在且视图未销毁；否则返回 false。

inherited fire(type, data, propagate){Object}

base/Evented.js, line 523

激发指定类型的事件

Name	Type	Description
type	string	可选 事件类型
data	Object	可选 待传递的数据
propagate	Boolean	可选 是否传播到父级

Returns:

Type	Description
Object	当前实例

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

base/Evented.js, line 337

移除事件
示例如下:
[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 240

注册一个新的监听事件;
示例如下：
[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)

onAdd(event){Promise.<LayerView>}

view/LayerView.js, line 45

将当前图层视图添加到引擎内部视图中。

该方法通常由具体图层视图子类重写，用于执行底层引擎对象创建、挂载和初始化逻辑。

Name	Type	Description
event	LayerEvent	可选 图层事件对象。

Returns:

Type	Description
Promise.<LayerView>	添加完成后返回当前图层视图对象。

onRefresh(){Promise.<LayerView>}

view/LayerView.js, line 197

刷新当前图层视图。

默认实现会先执行 onRemove，再执行 onAdd， 并通过防抖包装避免高频重复刷新。

Returns:

Type	Description
Promise.<LayerView>	刷新完成后返回当前图层视图对象。

onRemove(event){Promise.<LayerView>}

view/LayerView.js, line 58

将当前图层视图从引擎内部视图中移除。

该方法通常由具体图层视图子类实现，用于销毁底层引擎图层对象、解绑监听并释放相关资源。

Name	Type	Description
event	LayerEvent	可选 图层事件对象。

Returns:

Type	Description
Promise.<LayerView>	移除完成后返回当前图层视图对象。

onUpdate(event){Promise.<LayerView>}

view/LayerView.js, line 69

根据图层更新事件同步刷新当前图层视图状态。

当图层属性、样式或数据发生变化时，视图层会调用该方法执行对应更新逻辑。 具体更新行为由子类决定。

Name	Type	Description
event	LayerViewUpdateEvent	可选 图层视图更新事件对象。

Returns:

Type	Description
Promise.<LayerView>	更新完成后返回当前图层视图对象。

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

base/Evented.js, line 592

事件监听，仅触发一次

Name	Type	Description
types	string	可选 将侦听器函数（fn）添加到对象的特定事件类型中。您还可以传递几个空格分隔的类型（例如“click dblclick”），也可以传入例如 {click: onClick, mousemove: onMouseMove}。
fn	function	可选 侦听器函数
context	Object	可选 指定侦听器的上下文（this关键字将指向的对象）

Returns:

Type	Description
Object	当前实例