Spec-Zone.ru › OpenLayers

ol/source/VectorTile~VectorTile


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

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

new VectorTile(options)

source/VectorTile.js, line 102
Имя Тип Описание
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-тайлов), ваша tileLoadFunction не нуждается в вызове setLoader(). Убедитесь, что вы вызываете 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} плейсхолдеры. Может быть использован шаблон {?-?}, например subdomain{a-f}.domain.com, вместо отдельного определения каждого в опции urls.

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() inherited

Observable.js, line 68

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

clear() inherited

source/Tile.js, line 257

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

getKeys(){Array.<string>} inherited

Object.js, line 148

Возвращает список имён свойств объекта.

Возвращаемое значение:
Список имён свойств.

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(){State} 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. Возвращает функцию загрузки тайлов источника.

Возвращаемое значение:
Функция загрузки тайлов

getTileUrlFunction(){UrlFunction} inherited

source/UrlTile.js, line 110

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

Возвращаемое значение:
Функция URL тайлов

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

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

Name Type Description
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция прослушивания.

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

Однократное прослушивание события определённого типа.

Name Type Description
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция прослушивания.

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

set(key, value, silent) inherited

Object.js, line 215

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

Name Type Description
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновление без генерации события.

setAttributions(attributions) inherited

source/Source.js, line 203

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

Name Type Description
attributions AttributionLike | undefined

Атрибуты. Могут быть переданы как string, Array<string>, Attribution, или undefined.

setProperties(values, silent) inherited

Object.js, line 235

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

Name Type Description
values Object.<string, *>

Значения.

silent boolean | undefined

Обновление без генерации события.

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, line 161

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

Name Type Description
tileLoadFunction LoadFunction

Функция загрузки тайлов.

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, line 173

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

Name Type Description
tileUrlFunction UrlFunction

Функция URL тайлов.

key string | undefined

Необязательный новый ключ тайла для источника.

setUrl(url) inherited

source/UrlTile.js, line 187

Устанавливает URL для использования в запросах.

Name Type Description
url string

URL.

setUrls(urls) inherited

source/UrlTile.js, line 199

Устарело. Используйте вместо этого источник ImageTile. Устанавливает URLs для использования в запросах.

Name Type Description
urls Array.<string>

URLs.

un(type, listener) inherited

Observable.js, line 173

Отписаться от определённого типа события.

Имя Тип Описание
type строка | Массив.<строка>

Тип события или массив типов событий.

listener функция

Функция-обработчик.

unset(ключ, неявный) унаследованный

Object.js, строка 259

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

Имя Тип Описание
key строка

Имя ключа.

silent логическое | 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