ol/Object~BaseObject

import BaseObject from 'ol/Object.js';

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

Он расширяет Observable с наблюдаемыми свойствами, где каждое свойство наблюдаемо, а также объект в целом.

Классы, которые наследуются от этого класса, имеют предопределенные свойства, к которым вы можете добавить свои собственные. Предопределенные свойства перечислены в этой документации как «Наблюдаемые свойства» и имеют свои собственные методы доступа; например, Map имеет свойство target, к которому можно получить доступ с помощью getTarget(), и изменить с помощью setTarget(). Однако не все свойства могут быть изменены. Также существуют универсальные методы доступа get() и set(). Например, get('target') эквивалентно getTarget().

Методы доступа set вызывают событие изменения, и вы можете отслеживать его, зарегистрировав обработчик. Например, View имеет свойство center, поэтому view.on('change:center', function(evt) {...}); вызовет функцию каждый раз, когда изменяется значение свойства center. Внутри функции evt.target будет представлять собой представление, поэтому evt.target.getCenter() вернёт новое значение центра.

Вы можете добавить свои собственные наблюдаемые свойства с помощью object.set('prop', 'value'), и получить их с помощью object.get('prop'). Вы можете прослушивать изменения значения этого свойства с помощью object.on('change:prop', listener). Вы можете получить список всех свойств с помощью getProperties.

Обратите внимание, что наблюдаемые свойства отделены от стандартных свойств JavaScript. Например, вы можете присвоить вашему объекту карты заголовок с помощью map.title='New title' и с помощью map.set('title', 'Another title'). Первый будет hasOwnProperty; второй будет отображаться в getProperties(). Только второй наблюдаем.

Свойства можно удалить, используя метод unset. Например, object.unset('foo').

new BaseObject(values) Object.js, line 90

Имя	Тип	Описание
`values`	Object.<string, *> \| undefined	Объект со значениями пар ключ-значение.

Вызывает:

change (BaseEvent) — Общее событие изменения. Срабатывает при увеличении счётчика ревизии.
error (BaseEvent) — Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) — Срабатывает при изменении свойства.

Подклассы

Расширяет

Observable

Методы

changed() унаследованный Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследованный events/Target.js, строка 85

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

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

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

get(key){*} Object.js, строка 135

Получает значение.

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getKeys(){Array.<string>} Object.js, строка 148

Получает список имён свойств объекта.

Возвращает:

Список имён свойств.

getProperties(){Object.<string, *>} Object.js, строка 157

Получает объект со всеми именами и значениями свойств.

Возвращает:

Объект.

getRevision(){number} унаследованный Observable.js, строка 79

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

Возвращает:

Номер ревизии.

on(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

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

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция обработчика.

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 164

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

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция обработчика.

Возвращает:

set(key, value, silent) Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без запуска события.

setProperties(values, silent) Object.js, строка 235

Устанавливает набор пар "ключ-значение". Обратите внимание, что это изменяет любые существующие свойства и добавляет новые (это не удаляет какие-либо существующие свойства).

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновить без запуска события.

un(type, listener) унаследованный Observable.js, строка 173

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

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция обработчика.

unset(key, silent) Object.js, строка 259

Сбрасывает свойство.

Имя	Тип	Описание
`key`	строка	Имя ключа.
`silent`	логическое \| undefined	Сбросить без срабатывания события.