ImageWMS~ImageWMS

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

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

new ImageWMS(options) source/ImageWMS.js, строка 45

Имя	Тип	Описание
`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` при запросе изображения с удалённого сервера.
`serverType`	ServerType \| undefined	Тип удалённого сервера WMS: `mapserver`, `geoserver`, `carmentaserver` или `qgis`. Требуется только если `hidpi` имеет значение `true`.
`imageLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки изображения по URL.
`interpolate`	boolean (defaults to true)	Использовать интерполированные значения при повторной выборке. По умолчанию при повторной выборке используется линейная интерполяция. Установите значение false, чтобы вместо неё использовать метод ближайшего соседа.
`params`	Object.<string, *> \| undefined	Параметры запроса WMS. Требуется как минимум параметр `LAYERS`. По умолчанию `STYLES` имеет значение `''`. По умолчанию `VERSION` имеет значение `1.3.0`. Значения `WIDTH`, `HEIGHT`, `BBOX` и `CRS` (`SRS` для версии WMS < 1.3.0) будут задаваться динамически.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция вида.
`ratio`	number (defaults to 1.5)	Коэффициент. При значении `1` размер запрашиваемых изображений совпадает с размером области просмотра карты; при значении `2` ширина и высота изображений вдвое превышают размер области просмотра карты и так далее. Значение должно быть не меньше `1`.
`resolutions`	Array.<number> \| undefined	Разрешения. Если указаны, запросы будут выполняться только для этих разрешений.
`url`	string \| undefined	URL сервиса WMS.

События:

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

Возвращает:

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

getFeatureInfoUrl(coordinate, resolution, projection, params){string | undefined} source/ImageWMS.js, строка 138

Возвращает URL GetFeatureInfo для заданных координаты, разрешения и проекции. Возвращает undefined, если URL GetFeatureInfo невозможно сформировать.

Имя	Тип	Описание
`coordinate`	Coordinate	Координата.
`resolution`	number	Разрешение.
`projection`	ProjectionLike	Проекция.
`params`	Object	Параметры GetFeatureInfo. Необходимо указать как минимум `INFO_FORMAT`. Если `QUERY_LAYERS` не указан, будут использоваться слои, заданные параметром `LAYERS`. Здесь не следует указывать `VERSION`.

Возвращает:

URL GetFeatureInfo.

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

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

Возвращает:

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

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

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

Возвращает:

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

getLegendUrl(resolution, params){string | undefined} source/ImageWMS.js, строка 177

Возвращает URL GetLegendGraphic, при необходимости оптимизированный для заданного разрешения и, возможно, содержащий переданные специальные параметры. Возвращает undefined, если URL GetLegendGraphic невозможно сформировать.

Имя	Тип	Описание
`resolution`	number \| undefined	Разрешение. Если задано значение undefined, `SCALE` не будет вычислен и включён в URL.
`params`	Object \| undefined	Параметры GetLegendGraphic. Если задано `LAYER`, запрос формируется для этого слоя WMS, в противном случае будет использоваться настроенный слой WMS. Значение `FORMAT` по умолчанию — `image/png`. Здесь не следует указывать `VERSION`.

Возвращает:

URL GetLegendGraphic.

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

Получает заданные пользователем параметры, то есть переданные конструктору через параметр "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/ImageWMS.js, строка 249

Возвращает URL, используемый для этого источника WMS.

Возвращает:

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/ImageWMS.js, строка 258

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

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

setParams(params) source/ImageWMS.js, строка 281

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

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

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

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

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

setUrl(url) source/ImageWMS.js, строка 268

Задаёт 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/ImageWMS.js, строка 293

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

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