TileWMS~TileWMS

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

Источник слоёв для тайловых данных с серверов WMS.

new TileWMS(options) source/TileWMS.js, строка 78

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуция.
`attributionsCollapsible`	boolean (defaults to true)	Атрибуция может быть свёрнута.
`cacheSize`	number \| undefined	Устарело. Вместо этого используйте параметр cacheSize слоя.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загружаемых изображений. Обратите внимание: чтобы получать доступ к данным пикселей с помощью средства визуализации Canvas, необходимо указать значение `crossOrigin`. Подробнее см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`interpolate`	boolean (defaults to true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы вместо неё использовать метод ближайшего соседа.
`params`	Object.<string, *>	Параметры запроса WMS. Требуется указать как минимум параметр `LAYERS`. По умолчанию `STYLES` — `''`. По умолчанию `VERSION` — `1.3.0`. Параметры `WIDTH`, `HEIGHT`, `BBOX` и `CRS` (`SRS` для WMS версии < 1.3.0) будут установлены динамически.
`gutter`	number (defaults to 0)	Размер в пикселях поля вокруг тайлов изображений, которое следует игнорировать. Если задать ненулевое значение, будут запрашиваться изображения, ширина и высота которых превышают размер тайла на `2 x gutter`. Ненулевое значение позволяет игнорировать артефакты визуализации на границах тайлов. Если вы управляете службой WMS, рекомендуется устранить проблемы с «артефактами на границах тайлов» посредством правильной настройки службы WMS. Например, в MapServer для этого предусмотрен параметр конфигурации `tile_map_edge_buffer`. См. https://mapserver.org/output/tile_mode.html.
`hidpi`	boolean (defaults to true)	Использовать значение `ol/Map#pixelRatio` при запросе изображения с удалённого сервера.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция представления.
`reprojectionErrorThreshold`	number (defaults to 0.5)	Максимально допустимая погрешность перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
`tileClass`	Class<ImageTile> \| undefined	Класс для создания тайлов изображений. По умолчанию используется `ImageTile`.
`tileGrid`	TileGrid \| undefined	Сетка тайлов. Настройте её с учётом разрешений, размера тайла и охвата, поддерживаемых сервером. Если параметр не задан, будет использоваться сетка по умолчанию: если для проекции задан охват, сетка будет основана на нём; в противном случае будет использоваться сетка, основанная на глобальном охвате с началом координат в точке 0,0.
`serverType`	ServerType \| undefined	Тип удалённого сервера WMS: `mapserver`, `geoserver`, `carmentaserver` или `qgis`. Требуется, только если `hidpi` имеет значение `true`.
`tileLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки тайла по URL. По умолчанию используется function(imageTile, src) { imageTile.getImage().src = src; };
`url`	string \| undefined	URL службы WMS.
`urls`	Array.<string> \| undefined	URL службы WMS. Используйте этот параметр вместо `url`, если WMS поддерживает несколько URL для запросов GetMap.
`wrapX`	boolean (defaults to true)	Следует ли повторять мир по горизонтали. Если задано значение `false`, будет отображаться только один мир. Если задано значение `true`, тайлы будут запрашиваться только для одного мира, но повторяться по горизонтали для отображения нескольких миров.
`transition`	number \| undefined	Длительность перехода прозрачности при визуализации. Чтобы отключить переход прозрачности, передайте `transition: 0`.
`zDirection`	number \| NearestDirectionFunction (defaults to 0)	Выберите, использовать ли тайлы с более высоким или более низким уровнем масштабирования между целочисленными уровнями масштабирования. См. `getZForResolution`.

События:

change (BaseEvent) — Общее событие изменения. Вызывается при увеличении счётчика версий.
error (BaseEvent) — Общее событие ошибки. Вызывается при возникновении ошибки.
propertychange (ObjectEvent) — Вызывается при изменении свойства.
tileloadend (TileSourceEvent) — Вызывается после завершения загрузки тайла: когда его данные загружены или когда загрузка прервана, поскольку тайл больше не нужен.
tileloaderror (TileSourceEvent) — Вызывается, если при загрузке тайла произошла ошибка. Обратите внимание: это событие не следует использовать для повторной загрузки тайлов. Подробнее см. в разделе load.
tileloadstart (TileSourceEvent) — Вызывается при начале загрузки тайла.

Наследует

TileImage

Методы

changed() унаследовано Observable.js, строка 68

Увеличивает счётчик ревизии и отправляет событие 'change'.

clear() унаследовано source/Tile.js, строка 258

Удаляет все кэшированные перепроецированные тайлы из источника. При следующем цикле отрисовки будут созданы новые тайлы.

dispatchEvent(event){boolean | undefined} унаследовано events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр события может быть строкой или объектом со свойством 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/TileWMS.js, строка 159

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

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

Возвращает:

URL GetFeatureInfo.

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

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

Возвращает:

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

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

Возвращает 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/TileWMS.js, строка 281

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

Возвращает:

Состояние.

getTileGrid(){TileGrid | null} унаследовано source/Tile.js, строка 190

Возвращает сетку тайлов источника тайлов.

Возвращает:

Сетка тайлов.

getTileLoadFunction(){LoadFunction} унаследовано source/UrlTile.js, строка 100

Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию загрузки тайлов источника.

Возвращает:

TileLoadFunction

getTileUrlFunction(){UrlFunction} унаследовано source/UrlTile.js, строка 110

Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию URL тайлов источника.

Возвращает:

TileUrlFunction

getUrls(){!Array.<string> | null} унаследовано source/UrlTile.js, строка 124

Устарело. Вместо этого используйте источник ImageTile. Возвращает URL-адреса, используемые для этого источника. Если вместо url или urls используется tileUrlFunction, будет возвращено значение null.

Возвращает:

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

setParams(params) source/TileWMS.js, строка 358

Задаёт параметры URL, передаваемые источнику WMS.

Имя	Тип	Описание
`params`	Object	Новые параметры URL.

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

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

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

setRenderReprojectionEdges(render) унаследовано source/TileImage.js, строка 301

Задаёт, следует ли отрисовывать границы перепроецирования (обычно для отладки).

Имя	Тип	Описание
`render`	boolean	Отрисовывать границы.

setTileGridForProjection(projection, tilegrid) унаследовано source/TileImage.js, строка 321

Задаёт сетку тайлов, используемую при перепроецировании тайлов в указанную проекцию вместо сетки тайлов проекции по умолчанию.

Это может быть полезно, если сетку тайлов по умолчанию невозможно создать (например, для проекции не задана область охвата) или по причинам оптимизации (пользовательский размер тайла, разрешения и т. д.).

Имя	Тип	Описание
`projection`	ProjectionLike	Проекция.
`tilegrid`	TileGrid	Сетка тайлов, используемая для проекции.

setTileLoadFunction(tileLoadFunction) унаследовано source/UrlTile.js, строка 161

Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию загрузки тайлов источника.

Имя	Тип	Описание
`tileLoadFunction`	LoadFunction	Функция загрузки тайлов.

setTileUrlFunction(tileUrlFunction, key) унаследовано source/UrlTile.js, строка 173

Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию URL тайлов источника.

Имя	Тип	Описание
`tileUrlFunction`	UrlFunction	Функция URL тайлов.
`key`	string \| undefined	Новый ключ тайла для источника (необязательный).

setUrl(url) унаследовано source/UrlTile.js, строка 187

Задаёт URL, используемый для запросов.

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

setUrls(urls) унаследовано source/UrlTile.js, строка 199

Устарело. Вместо этого используйте источник ImageTile. Задаёт URL-адреса, используемые для запросов.

Имя	Тип	Описание
`urls`	Array.<string>	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/TileWMS.js, строка 368

Обновляет параметры URL. Этот метод можно использовать для обновления части параметров WMS. Вызовите setParams, чтобы задать все параметры.

Имя	Тип	Описание
`params`	Object	Обновлённые параметры URL.