Spec-Zone.ru › OpenLayers

ol/source/VectorTile~VectorTile 


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

Класс источников слоёв, предоставляющих векторные данные, разделённые на сетку тайлов, для использования с VectorTileLayer. Хотя этот источник получает с сервера тайлы с векторными объектами, он не предназначен для редактирования объектов. Объекты оптимизированы для отображения: их геометрия обрезается на границах тайлов или рядом с ними и упрощается с учётом разрешения представления. См. VectorSource — векторные источники, подходящие для редактирования объектов.

new VectorTile(options)

source/VectorTile.js, строка 107
Имя Тип Описание
attributions AttributionLike | undefined

Атрибуция.
attributionsCollapsible boolean (по умолчанию true)

Атрибуцию можно свернуть.
cacheSize number | undefined

Начальный размер кэша тайлов. Автоматически увеличивается, чтобы вмещать как минимум вдвое больше тайлов, чем находится в области просмотра.
extent Extent | undefined

Область.
format FeatureFormat<FeatureType> | undefined

Формат объектов для тайлов. Используется и требуется по умолчанию.
overlaps boolean (по умолчанию true)

В этом источнике могут быть перекрывающиеся геометрические объекты. Установка значения false (например, для источников с полигонами, представляющими административные границы, или для источников TopoJSON) позволяет средству отображения оптимизировать операции заливки и обводки.
projection ProjectionLike (по умолчанию 'EPSG:3857')

Проекция источника тайлов.
state State | undefined

Состояние источника.
tileClass Class<VectorTile> | undefined

Класс, используемый для создания экземпляров тайлов. По умолчанию используется VectorTile.
maxZoom number (по умолчанию 22)

Необязательный максимальный уровень масштаба. Не используется, если задан tileGrid.
minZoom number | undefined

Необязательный минимальный уровень масштаба. Не используется, если задан tileGrid.
tileSize number | Size (по умолчанию 512)

Необязательный размер тайла. Не используется, если задан tileGrid.
maxResolution number | undefined

Необязательное разрешение сетки тайлов на нулевом уровне. Не используется, если задан tileGrid.
tileGrid TileGrid | undefined

Сетка тайлов.
tileLoadFunction LoadFunction | undefined

Необязательная функция для загрузки тайла по URL. Для тайлов pbf она может выглядеть так:

function(tile, url) {
  tile.setLoader(function(extent, resolution, projection) {
    fetch(url).then(function(response) {
      response.arrayBuffer().then(function(data) {
        const format = tile.getFormat() // ol/format/MVT configured as source format
        const features = format.readFeatures(data, {
          extent: extent,
          featureProjection: projection
        });
        tile.setFeatures(features);
      });
    });
  });
}

Если для получения объектов тайла вам не нужны область, разрешение и проекция (например, для тайлов GeoJSON), вызов setLoader() в вашей tileLoadFunction не требуется. Нужно только вызвать setFeatures() для тайла:

const format = new GeoJSON({featureProjection: map.getView().getProjection()});
async function tileLoadFunction(tile, url) {
  const response = await fetch(url);
  const data = await response.json();
  tile.setFeatures(format.readFeatures(data));
}
tileUrlFunction UrlFunction | undefined

Необязательная функция для получения URL тайла по координатам тайла и проекции.
url string | undefined

Шаблон URL. Должен включать заполнители {x}, {y} или {-y}, а также {z}. Вместо отдельного указания каждого шаблона в параметре urls можно использовать шаблонный паттерн {?-?}, например subdomain{a-f}.domain.com.
transition number | undefined

Длительность перехода прозрачности тайла в миллисекундах. Длительность 0 отключает переход прозрачности.
urls Array.<string> | undefined

Массив шаблонов URL.
wrapX boolean (по умолчанию true)

Определяет, следует ли оборачивать мир по горизонтали. При значении false будет отображаться только один мир. При значении true тайлы будут оборачиваться по горизонтали для отображения нескольких миров.
zDirection number | NearestDirectionFunction (по умолчанию 1)

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

Подклассы

  • OGCVectorTile

Расширяет

  • UrlTile

Методы

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

Удалить без отправки события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_source_VectorTile-VectorTile.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API