ImageWMS~ImageWMS

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

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

новый ImageWMS(options) source/ImageWMS.js, строка 44

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Подписи.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание, что вам необходимо предоставить значение `crossOrigin`, если вы хотите получить доступ к данным пикселей с помощью рендерера Canvas. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`hidpi`	boolean (по умолчанию true)	Использовать значение `ol/Map#pixelRatio` при запросе изображения с удаленного сервера.
`serverType`	ServerType \| undefined	Тип удалённого сервера WMS: `mapserver`, `geoserver`, `carmentaserver` или `qgis`. Необходимо только если `hidpi` равно `true`.
`imageLoadFunction`	LoadFunction \| undefined	Дополнительная функция для загрузки изображения по URL.
`interpolate`	boolean (по умолчанию 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 (по умолчанию 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

Методы

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

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

Возвращаемое значение:

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

get(key){*} inherited Object.js, line 135

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

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

Возвращаемое значение:

Значение.

getAttributions(){Attribution} inherited source/Source.js, line 129

Получение функции атрибуции для источника.

Возвращаемое значение:

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

getAttributionsCollapsible(){boolean} inherited source/Source.js, line 137

Возвращаемое значение:

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

getFeatureInfoUrl(coordinate, resolution, projection, params){string | undefined} source/ImageWMS.js, line 131

Возвращает 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, line 232

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

Возвращаемое значение:

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

getKeys(){Array.<string>} inherited Object.js, line 148

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

Возвращаемое значение:

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

getLegendUrl(resolution, params){string | undefined} source/ImageWMS.js, line 170

Возвращает 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, line 189

Получает переданные пользователем параметры, т.е. те, которые были переданы в конструктор через опцию «params», и, возможно, обновлены с помощью метода updateParams.

Возвращаемое значение:

Параметры.

getProjection(){Projection | null} inherited source/Source.js, line 146

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

Возвращаемое значение:

Проекция.

getProperties(){Object.<string, *>} inherited Object.js, line 157

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

Возвращаемое значение:

Объект.

getRevision(){number} inherited Observable.js, line 79

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

Возвращаемое значение:

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

getState(){Состояние} унаследованный source/Source.js, строка 170

Получить состояние источника, см. State для возможных состояний.

Возвращает:

Состояние.

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

Возвращает 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, строка 192

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

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

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

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

setAttributions(attributions) унаследованный source/Source.js, строка 203

Устанавливает атрибуты источника.

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуты. Могут быть переданы как `string`, `Array<string>`, `Attribution` или `undefined`.

setImageLoadFunction(imageLoadFunction) source/ImageWMS.js, строка 250

Устанавливает функцию загрузки изображения для источника.

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

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

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

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

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

Устанавливает URL для запросов.

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

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

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

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

unset(key, silent) inherited Object.js, line 259

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

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

updateParams(params) source/ImageWMS.js, line 273

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

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