OGCMapTile~OGCMapTile

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

Источник слоя для картографических тайлов из сервиса OGC API - Tiles, предоставляющего тайлы типа «карта». Сервис должен соответствовать как минимум классам соответствия core (http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/core) и tileset (http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tileset). Для поддержки параметра collections сервис должен соответствовать классу соответствия collections selection (http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/collections-selection).

new OGCMapTile(options) source/OGCMapTile.js, строка 50

Имя	Тип	Описание
`url`	string	URL конечной точки набора тайлов OGC Map.
`context`	Object \| undefined	Сопоставление значений для использования в шаблоне URL тайла. Переменные `{tileMatrix}` (уровень масштабирования), `{tileRow}` и `{tileCol}` в URL всегда будут предоставляться источником.
`mediaType`	string \| undefined	Тип содержимого тайлов (например, "image/png"). Если он не указан, источник попытается найти ссылку с rel="item", в которой используется поддерживаемый тип изображения.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию проекция определяется по `crs` объекта `tileMatrixSet`. Это значение можно переопределить, указав проекцию в конструкторе.
`attributions`	AttributionLike \| undefined	Атрибуция.
`cacheSize`	number \| undefined	Устарело. Вместо этого используйте параметр cacheSize слоя.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание, что для доступа к данным пикселей с помощью средства визуализации Canvas необходимо указать значение `crossOrigin`. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`referrerPolicy`	ReferrerPolicy \| undefined	Свойство `referrerPolicy` для загруженных изображений.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы использовать интерполяцию методом ближайшего соседа.
`reprojectionErrorThreshold`	number (по умолчанию 0.5)	Максимально допустимая погрешность перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
`tileLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки тайла по URL. По умолчанию используется function(tile, src) { tile.getImage().src = src; };
`wrapX`	boolean (по умолчанию true)	Определяет, следует ли зацикливать мир по горизонтали.
`transition`	number \| undefined	Длительность перехода прозрачности при отрисовке. Чтобы отключить переход прозрачности, передайте `transition: 0`.
`collections`	Array.<string> \| undefined	Список подресурсов пространственных данных, которые нужно включить. Если список не указан, включается весь набор данных. Этот параметр не применяется при запросе набора тайлов для отдельной коллекции.

События:

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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	Удалить без отправки события.