ol/layer/VectorTile~VectorTileLayer
import VectorTileLayer from 'ol/layer/VectorTile.js';
Слой для данных векторных тайлов, которые отображаются на стороне клиента. Обратите внимание: каждое свойство, заданное в параметрах, устанавливается как свойство BaseObject объекта слоя; например, если задать title: 'My Title' в параметрах, это означает, что свойство title доступно для наблюдения и имеет методы доступа get/set.
-
new VectorTileLayer(options)
-
Имя Тип Описание classNamestring (по умолчанию 'ol-layer') Имя CSS-класса, назначаемого элементу слоя.
opacitynumber (по умолчанию 1) Непрозрачность (0, 1).
visibleboolean (по умолчанию true) Видимость.
extentExtent | undefined Границы области отображения слоя. За пределами этой области слой отображаться не будет.
zIndexnumber | undefined Z-индекс для отображения слоя. При отображении слои упорядочиваются сначала по Z-индексу, а затем по позиции. Если задано
undefined, для слоёв, добавленных в коллекциюlayersкарты, предполагается значениеzIndex, а для слоёв, добавленных с помощью методаsetMap(), — значениеInfinity.minResolutionnumber | undefined Минимальное разрешение (включительно), при котором слой будет виден.
maxResolutionnumber | undefined Максимальное разрешение (не включительно), ниже которого слой будет виден.
minZoomnumber | undefined Минимальный уровень масштабирования вида (не включительно), выше которого слой будет виден.
maxZoomnumber | undefined Максимальный уровень масштабирования вида (включительно), при котором слой будет виден.
renderOrderOrderFunction | undefined Порядок отображения. Функция, используемая для сортировки объектов перед отображением. По умолчанию объекты рисуются в порядке их создания. Используйте
null, чтобы отключить сортировку, но получить неопределённый порядок отображения.renderBuffernumber (по умолчанию 100) Буфер в пикселях вокруг границ тайла, используемый средством визуализации при получении объектов из векторного тайла для отображения или обнаружения попаданий. Рекомендуемое значение: векторные тайлы обычно создаются с буфером, поэтому это значение должно соответствовать максимальному буферу используемых тайлов. Оно должно быть не меньше размера самого крупного точечного символа или толщины линии.
renderModeVectorTileRenderType (по умолчанию 'hybrid') Режим отображения векторных тайлов:
'hybrid': полигоны и линии отображаются как изображения, поэтому во время анимации масштабирования пиксели масштабируются. Точечные символы и текст точно отображаются как векторы и могут оставаться вертикальными при повороте вида, но оказываются поверх всех полигонов и линий.'vector': всё отображается как векторы, при этом исходный порядок отображения сохраняется. Используйте этот режим для повышения производительности и качества изображения в слоях векторных тайлов с небольшим количеством отображаемых объектов (например, для выделения подмножества объектов другого слоя с тем же источником).sourceVectorTileSourceType | undefined Источник.
mapMap | undefined Устанавливает слой как наложение на карту. Карта не будет управлять этим слоем в своей коллекции слоёв, и слой будет отображаться поверх остальных. Это полезно для временных слоёв. Стандартный способ добавить слой на карту и передать управление им карте — использовать
map.addLayer().declutterboolean | string | number (по умолчанию false) Предотвращает наложение изображений и текста. Любое истинное значение включает предотвращение наложения. В пределах слоя объект, отображённый раньше другого, имеет более высокий приоритет. Для всех слоёв с одинаковым значением
declutterпредотвращение наложения выполняется совместно. Приоритет определяется порядком отрисовки слоёв с одинаковым значениемdeclutter. Чем выше слой в стеке, тем выше его приоритет. Чтобы отдельно предотвращать наложение для разных слоёв или групп слоёв, используйте разные истинные значения дляdeclutter.styleStyleLike | FlatStyleLike | null | undefined Стиль слоя. Если задано значение
null, будут отображаться только объекты с собственным стилем. Стиль по умолчанию, используемый, если это значение не задано, см. в разделеStyle.backgroundBackgroundColor | undefined Цвет фона слоя. Если не указан, фон отображаться не будет.
updateWhileAnimatingboolean (по умолчанию false) Если задано значение
true, во время анимации наборы объектов будут создаваться заново. Это означает, что векторы не будут обрезаться, но для больших объёмов векторных данных это снизит производительность. Если задано значениеfalse, наборы будут создаваться заново, когда анимация не выполняется.updateWhileInteractingboolean (по умолчанию false) Если задано значение
true, наборы объектов будут создаваться заново во время взаимодействия. См. такжеupdateWhileAnimating.preloadnumber (по умолчанию 0) Предварительная загрузка. Загружать тайлы с низким разрешением до
preloadуровней.0означает отсутствие предварительной загрузки.useInterimTilesOnErrorboolean (по умолчанию true) Устарело. Использовать промежуточные тайлы при ошибке.
propertiesObject.<string, *> | undefined Произвольные наблюдаемые свойства. Доступны через
#get()и#set().cacheSizenumber (по умолчанию 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)
-
Наследует
Наблюдаемые свойства
| Имя | Тип | Доступно для установки | Тип 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 | Источник слоя (или |
useInterimTilesOnError | boolean | да | change:useinterimtilesonerror | Использовать промежуточные тайлы при ошибке. |
visible | boolean | да | change:visible | Значение свойства |
zIndex | number | undefined | да | change:zindex | Z-индекс слоя. |
Методы
-
changed() унаследовано
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
dispatchEvent(event){boolean | undefined} унаследовано
-
Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр event может быть строкой или объектом со свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-либо вызвал preventDefault для объекта события или если любой из обработчиков вернул false.
-
get(key){*} унаследовано
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getAttributions(view){Array.<string>} унаследовано
-
Получает атрибуции источника этого слоя для указанного представления.
Имя Тип Описание viewView | ViewStateLayerStateExtent | undefined View или
FrameState. Требуется только в том случае, если слой не добавлен на карту.Возвращает:
Атрибуции этого слоя для указанного представления.
-
getBackground(){BackgroundColor}
-
Возвращает:
Цвет фона.
-
getExtent(){Extent | undefined} унаследовано
-
Возвращает
extentслоя илиundefined, если он будет виден независимо от экстента.Возвращает:
Экстент слоя.
-
getFeatures(pixel){Promise<Array<FeatureLike>>}
-
Получает верхний объект, пересекающийся с указанным пикселем в области просмотра. Возвращает промис, который разрешается массивом объектов. Если пересечение обнаружено, массив содержит верхний объект; в противном случае он будет пустым.
Алгоритм обнаружения пересечений, используемый этим методом, оптимизирован для повышения производительности, но менее точен, чем алгоритм метода
map.getFeaturesAtPixel(). Текст не учитывается, а значки представлены только ограничивающей рамкой, а не точным изображением.Имя Тип Описание pixelPixel Пиксель.
Возвращает:
Промис, который разрешается массивом объектов.
-
getFeaturesInExtent(extent){Array.<FeatureType>}
-
Получает объекты, ограничивающие рамки которых пересекаются с указанным экстентом. Источник содержит только объекты из кэшированных тайлов для последнего отрисованного уровня масштабирования. Поэтому этот метод подходит только для запроса тайлов в экстентах, которые отображаются в данный момент.
Объекты возвращаются в случайном порядке тайлов и в том виде, в котором они включены в тайлы. Это означает, что они могут быть обрезаны, продублированы в разных тайлах и упрощены до разрешения отрисовки.
Имя Тип Описание extentExtent Экстент.
Возвращает:
Объекты.
-
getKeys(){Array.<string>} унаследовано
-
Получает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getMaxResolution(){number} унаследовано
-
Возвращает максимальное разрешение слоя. Если максимальное разрешение не задано, возвращает Infinity.
Возвращает:
Максимальное разрешение слоя.
-
getMaxZoom(){number} унаследовано
-
Возвращает максимальный уровень масштабирования слоя. Если максимальный уровень масштабирования не задан, возвращает Infinity.
Возвращает:
Максимальный уровень масштабирования слоя.
-
getMinResolution(){number} унаследовано
-
Возвращает минимальное разрешение слоя. Если минимальное разрешение не задано, возвращает 0.
Возвращает:
Минимальное разрешение слоя.
-
getMinZoom(){number} унаследовано
-
Возвращает минимальный уровень масштабирования слоя. Если минимальный уровень масштабирования не задан, возвращает -Infinity.
Возвращает:
Минимальный уровень масштабирования слоя.
-
getOpacity(){number} унаследовано
-
Возвращает непрозрачность слоя (от 0 до 1).
Возвращает:
Непрозрачность слоя.
-
getPreload(){number}
-
Возвращает числовое значение уровня, до которого будут предварительно загружаться тайлы.
Возвращает:
Уровень, до которого предварительно загружаются тайлы.
-
getProperties(){NoInfer.<Properties>} унаследовано
-
Получает объект со всеми именами и значениями свойств.
Возвращает:
Объект.
-
getRevision(){number} унаследовано
-
Получает номер версии этого объекта. При каждом изменении объекта номер версии увеличивается.
Возвращает:
Ревизия.
-
getSource(){SourceType | null} унаследовано
-
Получает источник слоя.
Возвращает:
Источник слоя (илиnull, если он ещё не задан).
-
getStyle(){StyleLike | FlatStyleLike | null | undefined} унаследовано
-
Получает стиль объектов. Возвращает значение, переданное параметру
styleпри создании или методуsetStyle.Возвращает:
Стиль слоя.
-
getStyleFunction(){StyleFunction | undefined} унаследовано
-
Получает функцию стиля.
Возвращает:
Функция стиля слоя.
-
getUseInterimTilesOnError(){boolean}
-
Устарело. Определяет, используются ли промежуточные тайлы при ошибке.
Возвращает:
Использовать промежуточные тайлы при ошибке.
-
getVisible(){boolean} унаследовано
-
Возвращает значение свойства
visibleэтого слоя. Чтобы определить, виден ли слой на карте, используйтеisVisible().Возвращает:
Значение свойстваvisibleслоя.
-
getZIndex(){number | undefined} унаследовано
-
Возвращает Z-индекс слоя, используемый для упорядочивания слоёв перед отрисовкой. Если слой не управляется, возвращает undefined.
Возвращает:
Z-индекс слоя.
-
isVisible(view){boolean} унаследовано
-
Слой виден в представлении карты, то есть находится в пределах минимального/максимального разрешения или уровня масштабирования и экстента, для него не задано
visible: false, и он не входит в группу слоёв, для которой заданоvisible: false.Имя Тип Описание viewView | ViewStateLayerStateExtent | undefined View или
FrameState. Требуется только в том случае, если слой не добавлен на карту.Возвращает:
Видимость слоя в представлении карты.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Ожидает событие указанного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, возвращается массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Однократно ожидает событие указанного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, возвращается массив ключей.
-
set(key, value, silent) унаследовано
-
Задаёт значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновить без вызова события.
-
setBackground(background)
-
Имя Тип Описание backgroundBackgroundColor Цвет фона.
-
setDeclutter(declutter) унаследовано
-
Имя Тип Описание declutterboolean | string | number Устранять наложение изображений и текста.
-
setExtent(extent) унаследовано
-
Задаёт экстент, в пределах которого слой виден. Если
undefined, слой будет виден при любом экстенте.Имя Тип Описание extentExtent | undefined Экстент слоя.
-
setMap(map) унаследовано
-
Задаёт слой для отрисовки поверх других слоёв на карте. Карта не будет управлять этим слоем в своей коллекции слоёв. Это полезно для временных слоёв. Чтобы удалить неуправляемый слой с карты, используйте
#setMap(null).Чтобы добавить слой на карту и передать управление им карте, используйте вместо этого
addLayer.Имя Тип Описание mapMap | null Карта.
-
setMaxResolution(maxResolution) унаследовано
-
Задаёт максимальное разрешение, при котором слой виден.
Имя Тип Описание maxResolutionnumber Максимальное разрешение слоя.
-
setMaxZoom(maxZoom) унаследовано
-
Задайте максимальный масштаб (не включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования вида, который может отличаться от уровня масштабирования источника тайлов.
Имя Тип Описание maxZoomnumber Максимальный масштаб слоя.
-
setMinResolution(minResolution) унаследовано
-
Задайте минимальное разрешение, при котором слой виден.
Имя Тип Описание minResolutionnumber Минимальное разрешение слоя.
-
setMinZoom(minZoom) унаследовано
-
Задайте минимальный масштаб (включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования вида, который может отличаться от уровня масштабирования источника тайлов.
Имя Тип Описание minZoomnumber Минимальный масштаб слоя.
-
setOpacity(opacity) унаследовано
-
Задайте непрозрачность слоя; допустимые значения находятся в диапазоне от 0 до 1.
Имя Тип Описание opacitynumber Непрозрачность слоя.
-
setPreload(preload)
-
Задайте уровень — количество уровней, до которого будут предварительно загружаться тайлы.
Имя Тип Описание preloadnumber Уровень, до которого будут предварительно загружаться тайлы.
-
setProperties(values, silent) унаследовано
-
Задаёт набор пар «ключ — значение». Обратите внимание, что при этом изменяются все существующие свойства и добавляются новые (существующие свойства не удаляются).
Имя Тип Описание valuesPartial.<NoInfer.<Properties>> Значения.
silentboolean | undefined Обновить без вызова события.
-
setSource(source) унаследовано
-
Задайте источник слоя.
Имя Тип Описание sourceSourceType | null Источник слоя.
-
setStyle(style) унаследовано
-
Задайте стиль для объектов. Это может быть один объект стиля, массив стилей или функция, которая принимает объект и разрешение и возвращает массив стилей. Если задано значение
null, у слоя отсутствует стиль (стильnull), поэтому на слое будут отображаться только объекты с собственными стилями. ВызовитеsetStyle()без аргументов, чтобы восстановить стиль по умолчанию. Информацию о стиле по умолчанию см. в разделеthe ol/style/Style module.Если для слоя задан статический стиль, вместо конструкторов
Styleи символизаторов (Fill,Strokeи т. д.) можно использовать объектные литералыflat style:vectorLayer.setStyle({ "fill-color": "yellow", "stroke-color": "black", "stroke-width": 4 })Имя Тип Описание styleStyleLike | FlatStyleLike | null | undefined Стиль слоя.
-
setUseInterimTilesOnError(useInterimTilesOnError)
-
Устарело. Задайте, следует ли использовать промежуточные тайлы при ошибке.
Имя Тип Описание useInterimTilesOnErrorboolean Использовать промежуточные тайлы при ошибке.
-
setVisible(visible) унаследовано
-
Задайте видимость слоя (
trueилиfalse).Имя Тип Описание visibleboolean Видимость слоя.
-
setZIndex(zindex) унаследовано
-
Задайте Z-индекс слоя, который используется для упорядочивания слоёв перед отрисовкой. Z-индекс по умолчанию равен 0.
Имя Тип Описание zindexnumber Z-индекс слоя.
-
un(type, listener) унаследовано
-
Отменить прослушивание события указанного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
-
unset(key, silent) унаследовано
-
Удаляет свойство.
Имя Тип Описание keystring Имя ключа.
silentboolean | 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