Source~Source

import Source from 'ol/source/Source.js';

Абстрактный базовый класс; обычно используется только для создания подклассов и не создаётся в приложениях. Базовый класс для источников Layer.

При изменении состояния источника генерируется общее событие change.

new Source(options) source/Source.js, строка 51

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции.
`attributionsCollapsible`	boolean (defaults to true)	Атрибуции можно сворачивать.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция представления.
`state`	State (defaults to 'ready')	Состояние.
`wrapX`	boolean (defaults to false)	Оборачивание по X.
`interpolate`	boolean (defaults to false)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется метод ближайшего соседа.

Генерирует события:

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

Подклассы

Наследует

BaseObject

Методы

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	Имя ключа.

Возвращает:

Значение.

getAttributions(){Attribution} source/Source.js, строка 129

Возвращает функцию атрибуции источника.

Возвращает:

Функция атрибуции.

getAttributionsCollapsible(){boolean} source/Source.js, строка 137

Возвращает:

Атрибуции можно сворачивать.

getKeys(){Array.<string>} унаследован Object.js, строка 149

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

Возвращает:

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

getProjection(){Projection | null} source/Source.js, строка 146

Получает проекцию источника.

Возвращает:

Проекция.

getProperties(){NoInfer.<Properties>} унаследован Object.js, строка 158

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

Возвращает:

Объект.

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

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

Возвращает:

Ревизия.

getState(){State} source/Source.js, строка 201

Получает состояние источника. Возможные состояния см. в разделе State.

Возвращает:

Состояние.

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	Функция-обработчик.

Возвращает:

refresh() source/Source.js, строка 223

Обновляет источник. Источник будет очищен, а данные повторно загружены с сервера.

set(key, value, silent) унаследован Object.js, строка 218

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

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

setAttributions(attributions) source/Source.js, строка 234

Задаёт атрибуции источника.

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции можно передать как `string`, `Array<string>`, `Attribution` или `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	Удалить без отправки события.