ol/source/wms

Функции

createLoader(options){ImageObjectPromiseLoader}

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

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

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

Имя	Тип	Описание
crossOrigin	null | string | undefined	Атрибут crossOrigin для загружаемых изображений. Обратите внимание: чтобы получать данные пикселей с помощью средства визуализации Canvas, необходимо указать значение crossOrigin. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
referrerPolicy	ReferrerPolicy | undefined	Свойство referrerPolicy для загружаемых изображений.
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, строка 206

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 для загружаемых изображений. Обратите внимание: чтобы получать данные пикселей с помощью средства визуализации Canvas, необходимо указать значение crossOrigin. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
options.referrerPolicy	ReferrerPolicy | undefined	Свойство referrerPolicy для загружаемых изображений.
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, строка 256

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

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

Имя	Тип	Описание
options	LoaderOptions	Параметры, передаваемые функции createWMSLoader().
resolution	number | undefined	Разрешение. Если оно не задано, SCALE не будет вычислено и включено в URL.
options.crossOrigin	null | string | undefined	Атрибут crossOrigin для загружаемых изображений. Обратите внимание: чтобы получать данные пикселей с помощью средства визуализации Canvas, необходимо указать значение crossOrigin. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
options.referrerPolicy	ReferrerPolicy | undefined	Свойство referrerPolicy для загружаемых изображений.
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 GetLegendGraphic.

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

LoaderOptions{Object}

Свойства:

Имя	Тип	Описание
crossOrigin	null | string | undefined	Атрибут crossOrigin для загружаемых изображений. Обратите внимание: чтобы получать данные пикселей с помощью средства визуализации Canvas, необходимо указать значение crossOrigin. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
referrerPolicy	ReferrerPolicy | undefined	Свойство referrerPolicy для загружаемых изображений.
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.

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

Задайте тип сервера, чтобы использовать параметры, специфичные для конкретной реализации и выходящие за рамки спецификации WMS.

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