OGCVectorTile~OGCVectorTile

import OGCVectorTile from 'ol/source/OGCVectorTile.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).

Наборы векторных тайлов могут иметь различные форматы (например, GeoJSON, MVT). Параметр format определяет, какой из объявленных типов мультимедиа используется. Если необходимо принудительно использовать определённый тип мультимедиа, можно задать параметр mediaType.

new OGCVectorTile(options) source/OGCVectorTile.js, line 56

Имя	Тип	Описание
`url`	string	URL конечной точки набора векторных тайлов OGC.
`context`	Object \| undefined	Сопоставление значений, используемых в шаблоне URL тайла. Источник всегда предоставляет переменные `{tileMatrix}` (уровень масштаба), `{tileRow}` и `{tileCol}` в URL.
`format`	FeatureFormat<FeatureType> \| undefined	Формат объектов для тайлов. Используется и требуется по умолчанию.
`mediaType`	string \| undefined	Тип содержимого тайлов (например, "application/vnd.mapbox-vector-tile"). Если значение не задано, источник попытается найти ссылку с rel="item", использующую векторный тип, поддерживаемый настроенным форматом.
`attributions`	AttributionLike \| undefined	Атрибуции.
`attributionsCollapsible`	boolean (defaults to true)	Можно ли сворачивать атрибуции.
`cacheSize`	number \| undefined	Устарело. Вместо этого используйте параметр cacheSize слоя.
`overlaps`	boolean (defaults to true)	Источник может содержать перекрывающиеся геометрические объекты. Если задать `false` (например, для источников с полигонами, представляющими административные границы, или для источников TopoJSON), это позволит оптимизировать операции заливки и обводки.
`projection`	ProjectionLike (defaults to 'EPSG:3857')	Проекция сетки тайлов.
`tileClass`	Class<VectorTile> \| undefined	Класс, используемый для создания тайлов изображений. По умолчанию используется `VectorTile`.
`transition`	number \| undefined	Длительность переходов прозрачности тайлов в миллисекундах. Значение 0 отключает переход прозрачности.
`wrapX`	boolean (defaults to true)	Нужно ли горизонтально повторять мир. Если задано `false`, будет отображён только один мир. Если задано `true`, тайлы будут повторяться по горизонтали для отображения нескольких миров.
`zDirection`	number \| NearestDirectionFunction (defaults to 1)	Выберите, использовать ли тайлы с более высоким или более низким уровнем масштаба при промежуточных целочисленных уровнях масштаба. См. `getZForResolution`.
`collections`	Array.<string> \| undefined	Список геопространственных подресурсов, которые нужно включить. Если значение не задано, будет включён весь набор данных. Этот параметр не применяется при запросе набора тайлов для одной коллекции.

События:

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

Наследует

VectorTile

Методы

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

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