Spec-Zone.ru › OpenLayers

ol/Observable~Observable


import Observable from 'ol/Observable.js';

Абстрактный базовый класс; обычно используется только для создания подклассов, а не для создания экземпляров в приложениях. Целевая область событий, предоставляющая удобные методы для регистрации и отмены подписки на слушателей. Общее событие change всегда доступно через changed.

new Observable()

Observable.js, line 41
События:
  • change (BaseEvent) — Общее событие изменения. Срабатывает при увеличении счётчика ревизии.
  • error (BaseEvent) — Общее событие ошибки. Срабатывает при возникновении ошибки.

Подклассы

  • BaseObject

Расширяет

  • Target

Методы

changed()

Observable.js, line 68

Увеличивает счётчик ревизии и отправляет событие 'change'.

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

Отправляет событие и вызывает всех слушателей, подписных на события этого типа. Параметр события может быть строкой или объектом с свойством type.

Имя Тип Описание
event BaseEvent | string

Объект события.

Возвращает:
false, если кто-то вызвал preventDefault в объекте события или любой из слушателей вернул false.

getRevision(){number}

Observable.js, line 79

Получить номер версии этого объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.

Возвращает:
Номер ревизии.

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

Observable.js, line 152

Прослушивать события определённого типа.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-слушатель.

Возвращает:
Уникальный ключ для слушателя. Если вызван с массивом типов событий в качестве первого аргумента, возвращение будет массивом ключей.

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

Observable.js, line 164

Прослушивать событие определённого типа один раз.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-слушатель.

Возвращает:
Уникальный ключ для слушателя. Если вызван с массивом типов событий в качестве первого аргумента, возвращение будет массивом ключей.

un(type, listener)

Observable.js, line 173

Отменить прослушивание событий определённого типа.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-слушатель.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_Observable-Observable.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API