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.

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

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

new BaseObject(values) Object.js, строка 91

Имя	Тип	Описание
`values`	NoInfer.<Properties> \| 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	Объект события.

Возвращает:

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

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

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

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

Возвращает:

Значение.

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

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

Возвращает:

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

getProperties(){NoInfer.<Properties>} Object.js, строка 158

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

Возвращает:

Объект.

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, строка 218

Задаёт значение.

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

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

Задаёт набор пар «ключ — значение». Обратите внимание: при этом изменяются существующие свойства и добавляются новые (существующие свойства не удаляются).

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

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

Прекращает ожидание события указанного типа.

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

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

Удаляет свойство.

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