Class: Observable

ol/Observable~Observable


import Observable from 'ol/Observable.js';

抽象基类;通常只用于创建子类,不在应用中直接实例化。 提供便捷方法用于监听器注册和注销的事件目标。通用的 change 事件始终可通过 changed 使用。

new Observable()

触发事件:
  • change (BaseEvent) - 通用更改事件。当修订计数器增加时触发。
  • error (BaseEvent) - 通用错误事件。 当发生错误时触发。

Subclasses

Extends

Methods

changed()

增加修订计数器并分发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited

分发事件并调用所有监听此类型事件的监听器。事件参数可以是一个字符串或一个 具有 type 属性的对象。

Name Type Description
event BaseEvent | string

事件对象。

返回值:
如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false,则返回 false

getRevision(){number}

获取此对象的版本号。 每次对象被修改时,其版本号将递增。

返回值:
版本号。

on(type, listener){EventsKey | Array<EventsKey>}

监听特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。

once(type, listener){EventsKey | Array<EventsKey>}

仅监听一次特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。

un(type, listener)

取消监听特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。