OGCMap~OGCMap

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

Источник для серверов OGC Maps, предоставляющих отдельные изображения без тайлов.

new OGCMap(options) source/OGCMap.js, строка 38

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуция.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание: если вы хотите получать доступ к данным пикселей с помощью Canvas renderer, необходимо указать значение `crossOrigin`. Подробнее см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`referrerPolicy`	ReferrerPolicy \| undefined	Свойство `referrerPolicy` для загруженных изображений.
`hidpi`	boolean (defaults to true)	Использовать значение `ol/Map#pixelRatio` при запросе изображения с удалённого сервера.
`imageLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки изображения по URL.
`interpolate`	boolean (defaults to true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы вместо неё использовать метод ближайшего соседа.
`params`	Object.<string, *> \| undefined	Параметры запроса OGC Maps. По умолчанию ни один параметр не является обязательным. `width`, `height`, `bbox`, `crs` и `bbox-crs` будут задаваться динамически.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция вида.
`ratio`	number (defaults to 1.5)	Коэффициент. Значение `1` означает, что размеры запрашиваемых изображений соответствуют размеру области просмотра карты, `2` — что ширина и высота вдвое превышают размеры области просмотра карты, и так далее. Значение должно быть не меньше `1`.
`resolutions`	Array.<number> \| undefined	Разрешения. Если указаны, запросы будут выполняться только для этих разрешений.
`url`	string \| undefined	URL сервиса OGC Maps.

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

change (BaseEvent) — Общее событие изменения. Вызывается при увеличении счётчика ревизии.
error (BaseEvent) — Общее событие ошибки. Вызывается при возникновении ошибки.
imageloadend (ImageSourceEvent) — Вызывается после завершения загрузки изображения.
imageloaderror (ImageSourceEvent) — Вызывается, если при загрузке изображения произошла ошибка.
imageloadstart (ImageSourceEvent) — Вызывается при начале загрузки изображения.
propertychange (ObjectEvent) — Вызывается при изменении свойства.

Наследует

ImageSource

Методы

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

Возвращает:

Можно ли свернуть атрибуцию.

getImageLoadFunction(){LoadFunction} source/OGCMap.js, строка 160

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

Возвращает:

Функция загрузки изображений.

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

Возвращает список имён свойств объекта.

Возвращает:

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

getParams(){Object} source/OGCMap.js, строка 117

Возвращает параметры, переданные пользователем, то есть указанные при создании объекта в параметре "params" и, возможно, обновлённые с помощью метода updateParams.

Возвращает:

Параметры.

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.

Возвращает:

Состояние.

getUrl(){string | undefined} source/OGCMap.js, строка 169

Возвращает URL этого источника OGC Maps.

Возвращает:

URL.

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`.

setImageLoadFunction(imageLoadFunction) source/OGCMap.js, строка 178

Задаёт функцию загрузки изображений источника.

Имя	Тип	Описание
`imageLoadFunction`	LoadFunction	Функция загрузки изображений.

setParams(params) source/OGCMap.js, строка 201

Задаёт параметры, переданные пользователем.

Имя	Тип	Описание
`params`	Object	Параметры.

setProperties(values, silent) унаследовано Object.js, строка 238

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

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

setUrl(url) source/OGCMap.js, строка 188

Задаёт URL для запросов.

Имя	Тип	Описание
`url`	string \| undefined	URL.

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

Отписывается от события указанного типа.

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

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

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

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

updateParams(params) source/OGCMap.js, строка 213

Обновляет параметры, переданные пользователем.

Имя	Тип	Описание
`params`	Object	Параметры.