TileWMS~TileWMS

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

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

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

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Подписи.
`attributionsCollapsible`	boolean (по умолчанию true)	Подписи сворачиваются.
`cacheSize`	number \| undefined	Устарело. Используйте параметр cacheSize на слое вместо этого.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` загруженных изображений. Обратите внимание, что вы должны предоставить значение `crossOrigin`, если хотите получить доступ к пиксельным данным с помощью рендерера Canvas. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при ресемплинге. По умолчанию используется линейная интерполяция при ресемплинге. Установите в false, чтобы использовать ближайшего соседа вместо этого.
`params`	Object.<string, *>	Параметры запроса WMS. Необходим хотя бы параметр `LAYERS`. `STYLES` установлен по умолчанию в значение `''`. `VERSION` установлен по умолчанию в значение `1.3.0`. `WIDTH`, `HEIGHT`, `BBOX` и `CRS` (`SRS` для версии WMS < 1.3.0) будут установлены динамически.
`gutter`	number (по умолчанию 0)	Размер в пикселях отступа вокруг плиток изображений, который необходимо игнорировать. Установив это свойство в отличное от нуля значение, изображения будут запрашиваться шире и выше размера плитки на значение `2 x gutter`. Использование ненулевого значения позволяет игнорировать артефакты рендеринга на границах плиток. Если вы контролируете службу WMS, рекомендуется решить проблемы с «артефактами на границах плиток», правильно настроив службу WMS. Например, в MapServer есть параметр конфигурации `tile_map_edge_buffer` для этого. См. https://mapserver.org/output/tile_mode.html.
`hidpi`	boolean (по умолчанию true)	Использовать значение `ol/Map#pixelRatio` при запросе изображения с удаленного сервера.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию — проекция представления.
`reprojectionErrorThreshold`	number (по умолчанию 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 (по умолчанию true)	Обертывать мир по горизонтали. При значении `false` будет рендериться только один мир. При значении `true` плитки будут запрашиваться только для одного мира, но будут обернуты по горизонтали для рендеринга нескольких миров.
`transition`	number \| undefined	Продолжительность перехода непрозрачности при рендеринге. Для отключения перехода непрозрачности передайте значение `transition: 0`.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выбор использования плиток с более высоким или более низким уровнем масштабирования при значении между целочисленными уровнями масштабирования. См. `getZForResolution`.

События:

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

Расширяет

TileImage

Методы

changed() inherited Observable.js, line 68

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

clear() inherited source/Tile.js, line 257

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

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/TileWMS.js, line 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>} inherited Object.js, line 148

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

Возвращает:

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

getLegendUrl(resolution, params){string | undefined} source/TileWMS.js, line 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, line 281

Получить предоставленные пользователем параметры, т.е. те, что были переданы в конструктор через опцию «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(){Состояние} inherited source/Source.js, line 170

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

Возвращает:

Состояние.

getTileGrid(){TileGrid | null} inherited source/Tile.js, line 189

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

Возвращает:

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

getTileLoadFunction(){LoadFunction} inherited source/UrlTile.js, line 100

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

Возвращает:

TileLoadFunction

getTileUrlFunction(){UrlFunction} inherited source/UrlTile.js, line 110

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

Возвращает:

TileUrlFunction

getUrls(){!Array.<string> | null} inherited source/UrlTile.js, line 124

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

Возвращает:

URL-адреса.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

Прислушивается к определенному типу события.

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

Возвращает:

Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемым значением будет массив ключей.

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

Прислушиваться один раз к определенному типу события.

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

Возвращает:

set(key, value, silent) inherited Object.js, line 215

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

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

setAttributions(attributions) inherited source/Source.js, line 203

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

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

setProperties(values, silent) inherited Object.js, line 235

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

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

END_OF_DOCUMENT_MARKER

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

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

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

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

Устанавливает сетку тайлов для использования при репроекции тайлов в заданную проекцию вместо стандартной сетки тайлов для данной проекции.

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

Имя	Тип	Описание
`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, строка 259

Удаляет свойство.

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

updateParams(params) source/TileWMS.js, строка 348

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

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