Spec-Zone.ru › OpenLayers

ol/layer/VectorTile~VectorTileLayer


import VectorTileLayer from 'ol/layer/VectorTile.js';

Слой для данных векторных тайлов, которые отображаются на стороне клиента. Обратите внимание: каждое свойство, заданное в параметрах, устанавливается как свойство BaseObject объекта слоя; например, если задать title: 'My Title' в параметрах, это означает, что свойство title доступно для наблюдения и имеет методы доступа get/set.

new VectorTileLayer(options)

layer/VectorTile.js, строка 107
Имя Тип Описание
className string (по умолчанию 'ol-layer')

Имя CSS-класса, назначаемого элементу слоя.

opacity number (по умолчанию 1)

Непрозрачность (0, 1).

visible boolean (по умолчанию true)

Видимость.

extent Extent | undefined

Границы области отображения слоя. За пределами этой области слой отображаться не будет.

zIndex number | undefined

Z-индекс для отображения слоя. При отображении слои упорядочиваются сначала по Z-индексу, а затем по позиции. Если задано undefined, для слоёв, добавленных в коллекцию layers карты, предполагается значение zIndex, а для слоёв, добавленных с помощью метода setMap(), — значение Infinity.

minResolution number | undefined

Минимальное разрешение (включительно), при котором слой будет виден.

maxResolution number | undefined

Максимальное разрешение (не включительно), ниже которого слой будет виден.

minZoom number | undefined

Минимальный уровень масштабирования вида (не включительно), выше которого слой будет виден.

maxZoom number | undefined

Максимальный уровень масштабирования вида (включительно), при котором слой будет виден.

renderOrder OrderFunction | undefined

Порядок отображения. Функция, используемая для сортировки объектов перед отображением. По умолчанию объекты рисуются в порядке их создания. Используйте null, чтобы отключить сортировку, но получить неопределённый порядок отображения.

renderBuffer number (по умолчанию 100)

Буфер в пикселях вокруг границ тайла, используемый средством визуализации при получении объектов из векторного тайла для отображения или обнаружения попаданий. Рекомендуемое значение: векторные тайлы обычно создаются с буфером, поэтому это значение должно соответствовать максимальному буферу используемых тайлов. Оно должно быть не меньше размера самого крупного точечного символа или толщины линии.

renderMode VectorTileRenderType (по умолчанию 'hybrid')

Режим отображения векторных тайлов: 'hybrid': полигоны и линии отображаются как изображения, поэтому во время анимации масштабирования пиксели масштабируются. Точечные символы и текст точно отображаются как векторы и могут оставаться вертикальными при повороте вида, но оказываются поверх всех полигонов и линий. 'vector': всё отображается как векторы, при этом исходный порядок отображения сохраняется. Используйте этот режим для повышения производительности и качества изображения в слоях векторных тайлов с небольшим количеством отображаемых объектов (например, для выделения подмножества объектов другого слоя с тем же источником).

source VectorTileSourceType | undefined

Источник.

map Map | undefined

Устанавливает слой как наложение на карту. Карта не будет управлять этим слоем в своей коллекции слоёв, и слой будет отображаться поверх остальных. Это полезно для временных слоёв. Стандартный способ добавить слой на карту и передать управление им карте — использовать map.addLayer().

declutter boolean | string | number (по умолчанию false)

Предотвращает наложение изображений и текста. Любое истинное значение включает предотвращение наложения. В пределах слоя объект, отображённый раньше другого, имеет более высокий приоритет. Для всех слоёв с одинаковым значением declutter предотвращение наложения выполняется совместно. Приоритет определяется порядком отрисовки слоёв с одинаковым значением declutter. Чем выше слой в стеке, тем выше его приоритет. Чтобы отдельно предотвращать наложение для разных слоёв или групп слоёв, используйте разные истинные значения для declutter.

style StyleLike | FlatStyleLike | null | undefined

Стиль слоя. Если задано значение null, будут отображаться только объекты с собственным стилем. Стиль по умолчанию, используемый, если это значение не задано, см. в разделе Style.

background BackgroundColor | undefined

Цвет фона слоя. Если не указан, фон отображаться не будет.

updateWhileAnimating boolean (по умолчанию false)

Если задано значение true, во время анимации наборы объектов будут создаваться заново. Это означает, что векторы не будут обрезаться, но для больших объёмов векторных данных это снизит производительность. Если задано значение false, наборы будут создаваться заново, когда анимация не выполняется.

updateWhileInteracting boolean (по умолчанию false)

Если задано значение true, наборы объектов будут создаваться заново во время взаимодействия. См. также updateWhileAnimating.

preload number (по умолчанию 0)

Предварительная загрузка. Загружать тайлы с низким разрешением до preload уровней. 0 означает отсутствие предварительной загрузки.

useInterimTilesOnError boolean (по умолчанию true)

Устарело. Использовать промежуточные тайлы при ошибке.

properties Object.<string, *> | undefined

Произвольные наблюдаемые свойства. Доступны через #get() и #set().

cacheSize number (по умолчанию 0)

Внутренний размер кэша тайлов. Если он слишком мал, размер автоматически увеличится, чтобы вместить тайлы для двух уровней масштабирования.

События:
  • change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика ревизий.
  • change:extent (ObjectEvent)
  • change:maxResolution (ObjectEvent)
  • change:maxZoom (ObjectEvent)
  • change:minResolution (ObjectEvent)
  • change:minZoom (ObjectEvent)
  • change:opacity (ObjectEvent)
  • change:preload (ObjectEvent)
  • change:source (ObjectEvent)
  • change:useInterimTilesOnError (ObjectEvent)
  • change:visible (ObjectEvent)
  • change:zIndex (ObjectEvent)
  • error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
  • postrender (RenderEvent) — вызывается после отображения слоя.
  • prerender (RenderEvent) — вызывается перед отображением слоя.
  • propertychange (ObjectEvent) — вызывается при изменении свойства.
  • sourceready (BaseEvent)

Наследует

  • BaseVectorLayer

Наблюдаемые свойства

Имя Тип Доступно для установки Тип ObjectEvent Описание
extent Extent | undefined да change:extent

Область слоя.

maxResolution number да change:maxresolution

Максимальное разрешение слоя.

maxZoom number да change:maxzoom

Максимальный уровень масштабирования слоя.

minResolution number да change:minresolution

Минимальное разрешение слоя.

minZoom number да change:minzoom

Минимальный уровень масштабирования слоя.

opacity number да change:opacity

Непрозрачность слоя.

preload number да change:preload

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

source SourceType | null да change:source

Источник слоя (или null, если он ещё не задан).

useInterimTilesOnError boolean да change:useinterimtilesonerror

Использовать промежуточные тайлы при ошибке.

visible boolean да change:visible

Значение свойства visible слоя.

zIndex number | undefined да change:zindex

Z-индекс слоя.

Методы

changed() унаследовано

Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследовано

events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр event может быть строкой или объектом со свойством type.

Имя Тип Описание
event BaseEvent | string

Объект события.

Возвращает:
false, если кто-либо вызвал preventDefault для объекта события или если любой из обработчиков вернул false.

get(key){*} унаследовано

Object.js, строка 136

Получает значение.

Имя Тип Описание
key string

Имя ключа.

Возвращает:
Значение.

getAttributions(view){Array.<string>} унаследовано

layer/Layer.js, строка 349

Получает атрибуции источника этого слоя для указанного представления.

Имя Тип Описание
view View | ViewStateLayerStateExtent | undefined

View или FrameState. Требуется только в том случае, если слой не добавлен на карту.

Возвращает:
Атрибуции этого слоя для указанного представления.

getBackground(){BackgroundColor}

layer/VectorTile.js, строка 167
Возвращает:
Цвет фона.

getExtent(){Extent | undefined} унаследовано

layer/Base.js, строка 210

Возвращает extent слоя или undefined, если он будет виден независимо от экстента.

Возвращает:
Экстент слоя.

getFeatures(pixel){Promise<Array<FeatureLike>>}

layer/VectorTile.js, строка 199

Получает верхний объект, пересекающийся с указанным пикселем в области просмотра. Возвращает промис, который разрешается массивом объектов. Если пересечение обнаружено, массив содержит верхний объект; в противном случае он будет пустым.

Алгоритм обнаружения пересечений, используемый этим методом, оптимизирован для повышения производительности, но менее точен, чем алгоритм метода map.getFeaturesAtPixel(). Текст не учитывается, а значки представлены только ограничивающей рамкой, а не точным изображением.

Имя Тип Описание
pixel Pixel

Пиксель.

Возвращает:
Промис, который разрешается массивом объектов.

getFeaturesInExtent(extent){Array.<FeatureType>}

layer/VectorTile.js, строка 215

Получает объекты, ограничивающие рамки которых пересекаются с указанным экстентом. Источник содержит только объекты из кэшированных тайлов для последнего отрисованного уровня масштабирования. Поэтому этот метод подходит только для запроса тайлов в экстентах, которые отображаются в данный момент.

Объекты возвращаются в случайном порядке тайлов и в том виде, в котором они включены в тайлы. Это означает, что они могут быть обрезаны, продублированы в разных тайлах и упрощены до разрешения отрисовки.

Имя Тип Описание
extent Extent

Экстент.

Возвращает:
Объекты.

getKeys(){Array.<string>} унаследовано

Object.js, строка 149

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

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

getMaxResolution(){number} унаследовано

layer/Base.js, строка 223

Возвращает максимальное разрешение слоя. Если максимальное разрешение не задано, возвращает Infinity.

Возвращает:
Максимальное разрешение слоя.

getMaxZoom(){number} унаследовано

layer/Base.js, строка 256

Возвращает максимальный уровень масштабирования слоя. Если максимальный уровень масштабирования не задан, возвращает Infinity.

Возвращает:
Максимальный уровень масштабирования слоя.

getMinResolution(){number} унаследовано

layer/Base.js, строка 234

Возвращает минимальное разрешение слоя. Если минимальное разрешение не задано, возвращает 0.

Возвращает:
Минимальное разрешение слоя.

getMinZoom(){number} унаследовано

layer/Base.js, строка 245

Возвращает минимальный уровень масштабирования слоя. Если минимальный уровень масштабирования не задан, возвращает -Infinity.

Возвращает:
Минимальный уровень масштабирования слоя.

getOpacity(){number} унаследовано

layer/Base.js, строка 266

Возвращает непрозрачность слоя (от 0 до 1).

Возвращает:
Непрозрачность слоя.

getPreload(){number}

layer/VectorTile.js, строка 234

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

Возвращает:
Уровень, до которого предварительно загружаются тайлы.

getProperties(){NoInfer.<Properties>} унаследовано

Object.js, строка 158

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

Возвращает:
Объект.

getRevision(){number} унаследовано

Observable.js, строка 79

Получает номер версии этого объекта. При каждом изменении объекта номер версии увеличивается.

Возвращает:
Ревизия.

getSource(){SourceType | null} унаследовано

layer/Layer.js, строка 214

Получает источник слоя.

Возвращает:
Источник слоя (или null, если он ещё не задан).

getStyle(){StyleLike | FlatStyleLike | null | undefined} унаследовано

layer/BaseVector.js, строка 201

Получает стиль объектов. Возвращает значение, переданное параметру style при создании или методу setStyle.

Возвращает:
Стиль слоя.

getStyleFunction(){StyleFunction | undefined} унаследовано

layer/BaseVector.js, строка 210

Получает функцию стиля.

Возвращает:
Функция стиля слоя.

getUseInterimTilesOnError(){boolean}

layer/VectorTile.js, строка 244

Устарело. Определяет, используются ли промежуточные тайлы при ошибке.

Возвращает:
Использовать промежуточные тайлы при ошибке.

getVisible(){boolean} унаследовано

layer/Base.js, строка 285

Возвращает значение свойства visible этого слоя. Чтобы определить, виден ли слой на карте, используйте isVisible().

Возвращает:
Значение свойства visible слоя.

getZIndex(){number | undefined} унаследовано

layer/Base.js, строка 296

Возвращает Z-индекс слоя, используемый для упорядочивания слоёв перед отрисовкой. Если слой не управляется, возвращает undefined.

Возвращает:
Z-индекс слоя.

isVisible(view){boolean} унаследовано

layer/Layer.js, строка 305

Слой виден в представлении карты, то есть находится в пределах минимального/максимального разрешения или уровня масштабирования и экстента, для него не задано visible: false, и он не входит в группу слоёв, для которой задано visible: false.

Имя Тип Описание
view View | ViewStateLayerStateExtent | undefined

View или FrameState. Требуется только в том случае, если слой не добавлен на карту.

Возвращает:
Видимость слоя в представлении карты.

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

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

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

set(key, value, silent) унаследовано

Object.js, строка 218

Задаёт значение.

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновить без вызова события.

setBackground(background)

layer/VectorTile.js, строка 174
Имя Тип Описание
background BackgroundColor

Цвет фона.

setDeclutter(declutter) унаследовано

layer/BaseVector.js, строка 285
Имя Тип Описание
declutter boolean | string | number

Устранять наложение изображений и текста.

setExtent(extent) унаследовано

layer/Base.js, строка 316

Задаёт экстент, в пределах которого слой виден. Если undefined, слой будет виден при любом экстенте.

Имя Тип Описание
extent Extent | undefined

Экстент слоя.

setMap(map) унаследовано

layer/Layer.js, строка 444

Задаёт слой для отрисовки поверх других слоёв на карте. Карта не будет управлять этим слоем в своей коллекции слоёв. Это полезно для временных слоёв. Чтобы удалить неуправляемый слой с карты, используйте #setMap(null).

Чтобы добавить слой на карту и передать управление им карте, используйте вместо этого addLayer.

Имя Тип Описание
map Map | null

Карта.

setMaxResolution(maxResolution) унаследовано

layer/Base.js, строка 326

Задаёт максимальное разрешение, при котором слой виден.

Имя Тип Описание
maxResolution number

Максимальное разрешение слоя.

setMaxZoom(maxZoom) унаследовано

layer/Base.js, строка 348

Задайте максимальный масштаб (не включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования вида, который может отличаться от уровня масштабирования источника тайлов.

Имя Тип Описание
maxZoom number

Максимальный масштаб слоя.

setMinResolution(minResolution) унаследовано

layer/Base.js, строка 336

Задайте минимальное разрешение, при котором слой виден.

Имя Тип Описание
minResolution number

Минимальное разрешение слоя.

setMinZoom(minZoom) унаследовано

layer/Base.js, строка 360

Задайте минимальный масштаб (включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования вида, который может отличаться от уровня масштабирования источника тайлов.

Имя Тип Описание
minZoom number

Минимальный масштаб слоя.

setOpacity(opacity) унаследовано

layer/Base.js, строка 370

Задайте непрозрачность слоя; допустимые значения находятся в диапазоне от 0 до 1.

Имя Тип Описание
opacity number

Непрозрачность слоя.

setPreload(preload)

layer/VectorTile.js, строка 256

Задайте уровень — количество уровней, до которого будут предварительно загружаться тайлы.

Имя Тип Описание
preload number

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

setProperties(values, silent) унаследовано

Object.js, строка 238

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

Имя Тип Описание
values Partial.<NoInfer.<Properties>>

Значения.

silent boolean | undefined

Обновить без вызова события.

setSource(source) унаследовано

layer/Layer.js, строка 492

Задайте источник слоя.

Имя Тип Описание
source SourceType | null

Источник слоя.

setStyle(style) унаследовано

layer/BaseVector.js, строка 273

Задайте стиль для объектов. Это может быть один объект стиля, массив стилей или функция, которая принимает объект и разрешение и возвращает массив стилей. Если задано значение null, у слоя отсутствует стиль (стиль null), поэтому на слое будут отображаться только объекты с собственными стилями. Вызовите setStyle() без аргументов, чтобы восстановить стиль по умолчанию. Информацию о стиле по умолчанию см. в разделе the ol/style/Style module.

Если для слоя задан статический стиль, вместо конструкторов Style и символизаторов (Fill, Stroke и т. д.) можно использовать объектные литералы flat style:

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})
Имя Тип Описание
style StyleLike | FlatStyleLike | null | undefined

Стиль слоя.

setUseInterimTilesOnError(useInterimTilesOnError)

layer/VectorTile.js, строка 266

Устарело. Задайте, следует ли использовать промежуточные тайлы при ошибке.

Имя Тип Описание
useInterimTilesOnError boolean

Использовать промежуточные тайлы при ошибке.

setVisible(visible) унаследовано

layer/Base.js, строка 381

Задайте видимость слоя (true или false).

Имя Тип Описание
visible boolean

Видимость слоя.

setZIndex(zindex) унаследовано

layer/Base.js, строка 392

Задайте Z-индекс слоя, который используется для упорядочивания слоёв перед отрисовкой. Z-индекс по умолчанию равен 0.

Имя Тип Описание
zindex number

Z-индекс слоя.

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_layer_VectorTile-VectorTileLayer.html

Spec-Zone.ru

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