ol/layer/VectorTile~Слой векторной плитки

Расширяет

• BaseVectorLayer

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

Имя	Тип	Устанавливаемое	Тип ObjectEvent	Описание
extent	Extent | undefined	да	change:extent	Область слоя.
maxResolution	число	да	change:maxresolution	Максимальное разрешение слоя.
maxZoom	число	да	change:maxzoom	Максимальный уровень масштабирования слоя.
minResolution	число	да	change:minresolution	Минимальное разрешение слоя.
minZoom	число	да	change:minzoom	Минимальный уровень масштабирования слоя.
opacity	число	да	change:opacity	Непрозрачность слоя.
preload	число	да	change:preload	Уровень для предварительной загрузки тайлов.
source	SourceType | null	да	change:source	Источник слоя (или null, если он ещё не задан).
useInterimTilesOnError	логическое значение	да	change:useinterimtilesonerror	Использовать временные тайлы при ошибке.
visible	логическое значение	да	change:visible	Значение свойства visible слоя.
zIndex	число | undefined	да	change:zindex	Индекс Z слоя.

Методы

changed() inherited

Observable.js, line 68

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

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(view){Array.<string>} inherited

layer/Layer.js, line 345

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

Имя	Тип	Описание
view	View | ViewStateLayerStateExtent | undefined	Представление или FrameState. Требуется только в том случае, если слой не добавлен в карту.

Возвращает:

Атрибуты этого слоя в заданном представлении.

getBackground(){BackgroundColor}

layer/VectorTile.js, line 166

Возвращает:

Цвет фона.

getExtent(){Extent | undefined} inherited

layer/Base.js, line 207

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

Возвращает:

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

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

layer/VectorTile.js, line 200

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

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

Имя	Тип	Описание
pixel	Pixel	Пиксель.

Возвращает:

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

getFeaturesInExtent(extent){Array.<FeatureType>}

layer/VectorTile.js, line 216

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

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

Имя	Тип	Описание
extent	Extent	Область.

Возвращает:

Объекты.

getKeys(){Array.<string>} inherited

Object.js, line 148

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

Возвращает:

Список имён свойств.

getMaxResolution(){number} inherited

layer/Base.js, line 220

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

Возвращает:

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

getMaxZoom(){number} inherited

layer/Base.js, line 253

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

Возвращает:

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

getMinResolution(){number} inherited

layer/Base.js, line 231

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

Возвращает:

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

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

getPreload(){number}

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

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

Возвращает:

Уровень предварительной загрузки плиток.

getProperties(){Object.<string, *>} унаследованное

Object.js, строка 157

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

Возвращает:

Объект.

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

Observable.js, строка 79

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

Возвращает:

Номер версии.

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Стиль слоя.

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

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

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

Возвращает:

Функция стиля слоя.

getUseInterimTilesOnError(){boolean}

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

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

Возвращает:

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Индекс Z слоя.

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

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

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

Имя	Тип	Описание
view	Представление | ViewStateLayerStateExtent | undefined	Представление или FrameState. Требуется только тогда, когда слой не добавлен на карту.

Возвращает:

Слой виден на представлении карты.

on(type, listener){EventsKey | Array<EventsKey>} унаследованное

Observable.js, строка 152

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

Имя	Тип	Описание
type	строка | Array.<строка>	Тип события или массив типов событий.
listener	функция	Функция-обработчик.

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованное

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

setBackground(background)

layer/VectorTile.js, line 173

Name	Type	Description
background	BackgroundColor	Цвет фона.

setDeclutter(declutter) inherited

layer/BaseVector.js, line 288

Name	Type	Description
declutter	boolean | string | number	Убрать нагромождение изображений и текста.

setExtent(extent) inherited

layer/Base.js, line 313

Устанавливает область видимости слоя. Если undefined, слой будет виден при всех масштабах.

Name	Type	Description
extent	Extent | undefined	Область видимости слоя.

setMap(map) inherited

layer/Layer.js, line 440

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

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

Name	Type	Description
map	Map | null	Карта.

setMaxResolution(maxResolution) inherited

layer/Base.js, line 323

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

Name	Type	Description
maxResolution	number	Максимальное разрешение слоя.

setMaxZoom(maxZoom) inherited

layer/Base.js, line 345

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

Name	Type	Description
maxZoom	number	Максимальный масштаб слоя.

setMinResolution(minResolution) inherited

layer/Base.js, line 333

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

Name	Type	Description
minResolution	number	Минимальное разрешение слоя.

setMinZoom(minZoom) inherited

layer/Base.js, line 357

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

Name	Type	Description
minZoom	number	Минимальный масштаб слоя.

setOpacity(opacity) inherited

layer/Base.js, line 367

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

Name	Type	Description
opacity	number	Непрозрачность слоя.

setPreload(preload)

layer/VectorTile.js, line 257

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

Имя	Тип	Описание
preload	число	Уровень, до которого предварительно загружать тайлы.

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

Object.js, строка 235

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

Имя	Тип	Описание
values	Object.<string, *>	Значения.
silent	boolean | undefined	Обновить без срабатывания события.

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

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

Установить источник слоя.

Имя	Тип	Описание
source	SourceType | null	Источник слоя.

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

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

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

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

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})

Имя	Тип	Описание
style	StyleLike | FlatStyleLike | null | undefined	Стиль слоя.

setUseInterimTilesOnError(useInterimTilesOnError)

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

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

Имя	Тип	Описание
useInterimTilesOnError	boolean	Использовать временные тайлы при ошибке.

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

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

Установить видимость слоя (true или false).

Имя	Тип	Описание
visible	boolean	Видимость слоя.

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

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

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

Имя	Тип	Описание
zindex	число	Индекс Z слоя.

un(type, listener) унаследованный

Observable.js, строка 173

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

Имя	Тип	Описание
type	строка | Array.<string>	Тип события или массив типов событий.
listener	функция	Функция обработчика.

unset(key, silent) унаследованный

Object.js, строка 259

Удалить свойство.

Имя	Тип	Описание
key	строка	Имя ключа.
silent	boolean | undefined	Удалить без срабатывания события.