BaseVector~BaseVectorLayer

import BaseVectorLayer from 'ol/layer/BaseVector.js';

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

new BaseVectorLayer(options) layer/BaseVector.js, line 92

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-layer')	Имя класса CSS, которое нужно установить элементу слоя.
`opacity`	number (по умолчанию 1)	Непрозрачность (0, 1).
`visible`	boolean (по умолчанию true)	Видимость.
`extent`	Extent \| undefined	Граничная область для отрисовки слоя. Слой не будет отрисовываться за пределами этой области.
`zIndex`	number \| undefined	Индекс Z для отрисовки слоя. Во время отрисовки слои упорядочиваются сначала по индексу Z, а затем по позиции. Если `undefined`, для слоев, добавленных в коллекцию `layers` карты, предполагается `zIndex` значение 0, или `Infinity`, если для слоя был использован метод `setMap()`.
`minResolution`	number \| undefined	Минимальное разрешение (включительно), при котором этот слой будет виден.
`maxResolution`	number \| undefined	Максимальное разрешение (исключительно) ниже которого этот слой будет виден.
`minZoom`	number \| undefined	Минимальный уровень масштабирования (исключительно) выше которого этот слой будет виден.
`maxZoom`	number \| undefined	Максимальный уровень масштабирования (включительно) при котором этот слой будет виден.
`renderOrder`	OrderFunction \| undefined	Порядок отрисовки. Функция, используемая для сортировки объектов перед отрисовкой. По умолчанию объекты отрисовываются в порядке их создания. Используйте `null`, чтобы избежать сортировки, но получить неопределенный порядок отрисовки.
`renderBuffer`	number (по умолчанию 100)	Буфер в пикселях вокруг области просмотра, используемый рендерером при получении объектов из источника векторных данных для отрисовки или определения попадания. Рекомендуемое значение: размер самого большого символа, ширины линии или метки.
`source`	VectorSourceType \| 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`.
`properties`	Object.<string, *> \| undefined	Произвольные наблюдаемые свойства. К ним можно получить доступ с помощью `#get()` и `#set()`.

События:

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

Подклассы

Расширяет

Layer

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

Имя	Тип	Устанавливаемое	Тип ObjectEvent	Описание
`extent`	Extent \| undefined	да	`change:extent`	Область слоя.
`maxResolution`	число	да	`change:maxresolution`	Максимальное разрешение слоя.
`maxZoom`	число	да	`change:maxzoom`	Максимальный уровень масштабирования слоя.
`minResolution`	число	да	`change:minresolution`	Минимальное разрешение слоя.
`minZoom`	число	да	`change:minzoom`	Минимальный уровень масштабирования слоя.
`opacity`	число	да	`change:opacity`	Непрозрачность слоя.
`source`	SourceType \| null	да	`change:source`	Источник слоя (или `null`, если ещё не задан).
`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

Отправляет событие и вызывает все обработчики, слушающие события этого типа. Параметр event может быть строкой или объектом с свойством 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`	Представление \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Требуется только в том случае, если слой не добавлен в карту.

Возвращает:

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

getExtent(){Extent | undefined} inherited layer/Base.js, line 207

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

Возвращает:

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

getFeatures(pixel){Promise<Array<FeatureLike>>} layer/BaseVector.js, line 178

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

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

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

Возвращает:

Промис, разрешающий массив элементов.

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} inherited layer/Base.js, line 242

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

Возвращает:

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

getOpacity(){number} inherited layer/Base.js, line 263

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

Возвращает:

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

getProperties(){Object.<string, *>} inherited Object.js, line 157

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

Возвращает:

Объект.

getRevision(){number} inherited Observable.js, line 79

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

Возвращает:

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

getSource(){SourceType | null} inherited layer/Layer.js, line 209

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

Возвращает:

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

getStyle(){StyleLike | FlatStyleLike | null | undefined} layer/BaseVector.js, line 204

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

Возвращает:

Стиль слоя.

getStyleFunction(){StyleFunction | undefined} layer/BaseVector.js, line 213

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

Возвращает:

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

getVisible(){boolean} inherited layer/Base.js, line 282

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

Возвращает:

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

getZIndex(){number | undefined} inherited layer/Base.js, line 293

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

Возвращает:

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

isVisible(view){boolean} inherited layer/Layer.js, line 301

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

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

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

Прослушать событие определенного типа один раз.

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

Возвращает:

set(key, value, silent) inherited Object.js, line 215

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

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

setDeclutter(declutter) layer/BaseVector.js, line 288

Имя	Тип	Описание
declutter	boolean \| строка \| число	Сгруппировать изображения и текст.

setExtent(extent) inherited layer/Base.js, line 313

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

Имя	Тип	Описание
`extent`	Extent \| undefined	Область видимости слоя.

setMap(map) inherited layer/Layer.js, строка 440

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

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

Имя	Тип	Описание
`map`	Map \| null	Карта.

setMaxResolution(maxResolution) inherited layer/Base.js, строка 323

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

Имя	Тип	Описание
`maxResolution`	number	Максимальное разрешение слоя.

setMaxZoom(maxZoom) inherited layer/Base.js, строка 345

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

Имя	Тип	Описание
`maxZoom`	number	Максимальный масштаб слоя.

setMinResolution(minResolution) inherited layer/Base.js, строка 333

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

Имя	Тип	Описание
`minResolution`	number	Минимальное разрешение слоя.

setMinZoom(minZoom) inherited layer/Base.js, строка 357

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

Имя	Тип	Описание
`minZoom`	number	Минимальный масштаб слоя.

setOpacity(opacity) inherited layer/Base.js, строка 367

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

Имя	Тип	Описание
`opacity`	number	Непрозрачность слоя.

setProperties(values, silent) inherited Object.js, строка 235

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

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

setSource(source) inherited 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	Стиль слоя.

setVisible(visible) inherited layer/Base.js, строка 378

END_OF_DOCUMENT_MARKER

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

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

setZIndex(zindex) унаследованный layer/Base.js, строка 389

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

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

un(type, listener) унаследованный Observable.js, строка 173

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

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

unset(key, silent) унаследованный Object.js, строка 259

Сброс свойства.

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