KBE3D / KBCore / utils / BaseClass

抽象 类: BaseClass

基础类，SDK中所有类的基类

继承于

• Earth
• BaseEffect
• BaseLayer
• Popup

属性

originOptions

readonly originOptions: any

原始构造参数备份

---

uuid

readonly uuid: string

实例的唯一ID

方法

destroy()

destroy(force?: boolean): void

销毁当前对象，delete所有属性

参数

force?

boolean = true

返回

void

方法: 事件相关

on()

on(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): BaseClass

绑定指定类型事件监听器，支持在监听中调用 event.stopPropagation() 组织事件冒泡

参数

types

事件类型

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn

Function

绑定的监听器回调方法

context?

any

侦听器的上下文(this关键字将指向的对象)。

返回

BaseClass

当前对象本身，可以链式调用

---

off()

off(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): BaseClass

解除绑定指定类型事件监听器

参数

types

事件类型,未传值时解绑所有事件

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn

Function

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件

context?

any

侦听器的上下文(this关键字将指向的对象)。

返回

BaseClass

当前对象本身,可以链式调用

---

emit()

emit(type: string, data?: any, propagate?: boolean): BaseClass

触发指定类型的事件。

参数

type

string

事件类型

data?

any

传输的数据或对象，可在事件回调方法中event对象中获取进行使用

propagate?

boolean

将事件传播给父类 (用addEventParent设置)

返回

BaseClass

当前对象本身,可以链式调用

---

once()

once(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): BaseClass

绑定一次性执行的指定类型事件监听器，与on类似，监听器只会被触发一次，然后被删除

参数

types

事件类型

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn

Function

绑定的监听器回调方法

context?

any

侦听器的上下文(this关键字将指向的对象)

返回

BaseClass

当前对象本身,可以链式调用

---

hasListener()

hasListener(type: string, propagate?: boolean): boolean

是否有绑定指定的事件

参数

type

string

事件类型

propagate?

boolean

是否判断指定的父类 (用addEventParent设置的)

返回

boolean

是否存在

---

addEventParent()

addEventParent(obj: BaseClass): BaseClass

添加抛出事件到父类，它将接收传播的事件

参数

obj

BaseClass

父类对象

返回

BaseClass

当前对象本身,可以链式调用

---

removeEventParent()

removeEventParent(obj: BaseClass): BaseClass

移除抛出事件到父类

参数

obj

BaseClass

父类对象

返回

BaseClass

当前对象本身,可以链式调用

---

hasEventParent()

hasEventParent(obj: BaseClass): boolean

是否绑定了抛出事件到指定父类

参数

obj

BaseClass

父类对象

返回

boolean

当前对象本身,可以链式调用

构造函数

构造函数

new BaseClass(originOptions?: any): BaseClass

参数

originOptions?

any

构造参数

返回

BaseClass

实例对象