Layer~Layer

import Layer from 'ol/layer/Layer.js';

Базовый класс, от которого производны все типы слоёв. Его следует создавать только в случае добавления на карту пользовательского слоя с пользовательской функцией render. Такую функцию можно указать в объекте options; она должна возвращать HTML-элемент.

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

Слои обычно добавляют на карту с помощью map.addLayer(). Такие компоненты, как Draw, внутри используют неуправляемые слои. Вместо этого эти неуправляемые слои связываются с картой с помощью layer.setMap().

При изменении состояния источника генерируется общее событие change. Когда источник слоя готов, генерируется событие sourceready.

new Layer(options) layer/Layer.js, строка 105

Имя	Тип	Описание
`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, а если использовался метод `setMap()` слоя — значение `Infinity`.
`minResolution`	number \| undefined	Минимальное разрешение (включительно), при котором этот слой будет виден.
`maxResolution`	number \| undefined	Максимальное разрешение (не включительно), ниже которого этот слой будет виден.
`minZoom`	number \| undefined	Минимальный уровень масштабирования вида (не включительно), выше которого этот слой будет виден.
`maxZoom`	number \| undefined	Максимальный уровень масштабирования вида (включительно), при котором этот слой будет виден.
`source`	SourceType \| undefined	Источник для этого слоя. Если источник не передан конструктору, его можно задать после создания, вызвав `layer.setSource(source)`.
`map`	Map \| null \| undefined	Карта.
`render`	RenderFunction \| undefined	Функция отрисовки. Принимает состояние кадра и должна возвращать HTML-элемент. Заменяет стандартную отрисовку слоя.
`background`	BackgroundColor \| undefined	Цвет фона слоя. Если он не указан, фон не отрисовывается.
`properties`	Properties \| 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)

Подклассы

Наследует

BaseLayer

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

Имя	Тип	Можно задать	Тип события 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`	Непрозрачность слоя.
`source`	SourceType \| null	да	`change:source`	Источник слоя (или `null`, если ещё не задан).
`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	Представление или `FrameState`. Требуется только в том случае, если слой не добавлен на карту.

Возвращает:

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

getExtent(){Extent | undefined} унаследовано layer/Base.js, строка 210

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

Возвращает:

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

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).

Возвращает:

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

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

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

Возвращает:

Объект.

getRevision(){number} унаследовано Observable.js, строка 79

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

Возвращает:

Ревизия.

getSource(){SourceType | null} layer/Layer.js, строка 214

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

Возвращает:

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

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	Представление или `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	Обновить без вызова события.

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	Непрозрачность слоя.

setProperties(values, silent) унаследовано Object.js, строка 238

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

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

setSource(source) layer/Layer.js, строка 492

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

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

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	Удалить без вызова события.