ol/source/wms

Функции

createLoader(options){ImageObjectPromiseLoader}

source/wms.js, строка 162

import {createLoader} from 'ol/source/wms';

Создаёт загрузчик для изображений WMS.

Имя	Тип	Описание
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 при запросе изображения с удалённого сервера.
params	Object.<string, *> | undefined	Параметры запроса WMS. Требуется по крайней мере параметр LAYERS. STYLES по умолчанию устанавливается в значение ''. VERSION по умолчанию устанавливается в значение 1.3.0. WIDTH, HEIGHT и BBOX будут установлены динамически. CRS (SRS для версии WMS < 1.3.0) выводится из конфигурации proection.
projection	ProjectionLike | undefined	Проекция. По умолчанию 'EPSG:3857'.
ratio	number (по умолчанию 1.5)	Коэффициент. 1 означает, что запросы изображений соответствуют размеру области видимости карты, 2 означает дважды ширину и высоту области видимости карты и так далее. Должно быть 1 или выше.
serverType	ServerType | undefined	Тип удаленного сервера WMS: mapserver, geoserver, carmentaserver или qgis. Требуется только если hidpi имеет значение true.
url	string	URL сервиса WMS.
load	function | undefined	Функция для загрузки изображения. Получает созданный HTMLImageElement и требуемое src в качестве аргументов и возвращает промис, разрешающий загруженное или декодированное изображение. По умолчанию decode.

Возвращает:

Загрузчик.

getFeatureInfoUrl(options, coordinate, resolution){string | undefined}

source/wms.js, строка 201

import {getFeatureInfoUrl} from 'ol/source/wms';

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

Имя	Тип	Описание
options	LoaderOptions	Опции, переданные функции createWMSLoader(). В дополнение к параметрам, необходимым для загрузчика, необходимо указать INFO_FORMAT, которое по умолчанию равно application/json. Если QUERY_LAYERS не предоставлен, то будут использованы слои, указанные в параметре LAYERS.
coordinate	Coordinate	Координаты.
resolution	number	Разрешение.
options.crossOrigin	null | string | undefined	Атрибут crossOrigin загружаемых изображений. Обратите внимание, что вам необходимо указать значение crossOrigin, если вы хотите получить доступ к пиксельным данным с помощью рендерера Canvas. Дополнительную информацию см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
options.hidpi	boolean (по умолчанию true)	Использовать значение ol/Map#pixelRatio при запросе изображения с удалённого сервера.
options.params	Object.<string, *> | undefined	Параметры запроса WMS. Требуется по крайней мере параметр LAYERS. STYLES по умолчанию устанавливается в значение ''. VERSION по умолчанию устанавливается в значение 1.3.0. WIDTH, HEIGHT и BBOX будут установлены динамически. CRS (SRS для версии WMS < 1.3.0) выводится из конфигурации proection.
options.projection	ProjectionLike | undefined	Проекция. По умолчанию 'EPSG:3857'.
options.ratio	number (по умолчанию 1.5)	Коэффициент. 1 означает, что запросы изображений соответствуют размеру области видимости карты, 2 означает дважды ширину и высоту области видимости карты и так далее. Должно быть 1 или выше.
options.serverType	ServerType | undefined	Тип удаленного сервера WMS: mapserver, geoserver, carmentaserver или qgis. Требуется только если hidpi имеет значение true.
options.url	string	URL сервиса WMS.
options.load	function | undefined	Функция для загрузки изображения. Получает созданный HTMLImageElement и требуемое src в качестве аргументов и возвращает промис, разрешающий загруженное или декодированное изображение. По умолчанию decode.

Возвращает:

URL GetFeatureInfo.

getLegendUrl(options, resolution){string | undefined}

source/wms.js, строка 251

import {getLegendUrl} from 'ol/source/wms';

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

Имя	Тип	Описание
options	LoaderOptions	Параметры, переданные в функцию createWMSLoader().
resolution	число | undefined	Разрешение. Если не указано, SCALE не будет вычислен и не будет включен в URL.
options.crossOrigin	null | строка | undefined	Атрибут crossOrigin для загружаемых изображений. Обратите внимание, что вам необходимо указать значение crossOrigin, если вы хотите получить доступ к данным пикселей с помощью рендерера Canvas. Подробнее см. в https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
options.hidpi	логическое значение (по умолчанию true)	Использовать значение ol/Map#pixelRatio при запросе изображения с удаленного сервера.
options.params	Объект.<строка, *> | undefined	Параметры запроса WMS. Требуется по крайней мере параметр LAYERS. STYLES установлено по умолчанию ''. VERSION установлено по умолчанию 1.3.0. WIDTH, HEIGHT и BBOX будут установлены динамически. CRS (SRS для версии WMS < 1.3.0) выводится из конфигурации proection.
options.projection	ProjectionLike | undefined	Проекция. По умолчанию 'EPSG:3857'.
options.ratio	число (по умолчанию 1.5)	Соотношение. 1 означает, что запросы изображений имеют размер области просмотра карты, 2 означает удвоенную ширину и высоту области просмотра карты, и так далее. Должно быть 1 или больше.
options.serverType	ServerType | undefined	Тип удаленного сервера WMS: mapserver, geoserver, carmentaserver или qgis. Требуется только в том случае, если hidpi равно true.
options.url	строка	URL сервиса WMS.
options.load	функция | undefined	Функция для загрузки изображения. Получает созданный HTMLImageElement и желаемое src в качестве аргументов и возвращает промис, разрешающий загруженное или декодированное изображение. По умолчанию decode.

Возвращает:

URL GetLegendGraphic.

Определения типов

LoaderOptions{Object}

Свойства:

Имя	Тип	Описание
crossOrigin	null | строка | undefined	Атрибут crossOrigin для загружаемых изображений. Обратите внимание, что вам необходимо указать значение crossOrigin, если вы хотите получить доступ к данным пикселей с помощью рендерера Canvas. Подробнее см. в https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
hidpi	логическое значение (по умолчанию true)	Использовать значение ol/Map#pixelRatio при запросе изображения с удаленного сервера.
params	Объект.<строка, *> | undefined	Параметры запроса WMS. Требуется по крайней мере параметр LAYERS. STYLES установлено по умолчанию ''. VERSION установлено по умолчанию 1.3.0. WIDTH, HEIGHT и BBOX будут установлены динамически. CRS (SRS для версии WMS < 1.3.0) выводится из конфигурации proection.
projection	ProjectionLike | undefined	Проекция. По умолчанию 'EPSG:3857'.
ratio	число (по умолчанию 1.5)	Соотношение. 1 означает, что запросы изображений имеют размер области просмотра карты, 2 означает удвоенную ширину и высоту области просмотра карты, и так далее. Должно быть 1 или больше.
serverType	ServerType | undefined	Тип удаленного сервера WMS: mapserver, geoserver, carmentaserver или qgis. Требуется только в том случае, если hidpi равно true.
url	строка	URL сервиса WMS.
load	функция | undefined	Функция для загрузки изображения. Получает созданный HTMLImageElement и желаемое src в качестве аргументов и возвращает промис, разрешающий загруженное или декодированное изображение. По умолчанию decode.

ServerType{'carmentaserver'} {'geoserver'} {'mapserver'} {'qgis'}

Установите тип сервера для использования реализующих параметров, выходящих за рамки спецификации WMS.

• 'carmentaserver': Поддержка HiDPI для Carmenta Server
• 'geoserver': Поддержка HiDPI для GeoServer
• 'mapserver': Поддержка HiDPI для MapServer
• 'qgis': Поддержка HiDPI для QGIS