Group~Группа слоёв

import LayerGroup from 'ol/layer/Group.js';

A Collection of layers that are handled together.

A generic change event is triggered when the group/Collection changes.

new LayerGroup(options) layer/Group.js, line 89

Имя	Тип	Описание
`opacity`	number (defaults to 1)	Непрозрачность (0, 1).
`visible`	boolean (defaults to true)	Видимость.
`extent`	Extent \| undefined	Граница отображения слоя. Слой не будет отображаться за пределами этой границы.
`zIndex`	number \| undefined	Индекс Z для отображения слоя. Во время отрисовки слои упорядочиваются сначала по индексу Z, а затем по положению. Если `undefined`, для слоёв, добавленных в коллекцию `layers` карты, предполагается индекс Z равный 0, или `Infinity`, когда использовался метод `setMap()` слоя.
`minResolution`	number \| undefined	Минимальное разрешение (включительно), при котором этот слой будет виден.
`maxResolution`	number \| undefined	Максимальное разрешение (исключительно), ниже которого этот слой будет виден.
`minZoom`	number \| undefined	Минимальный уровень масштаба просмотра (исключительно), выше которого этот слой будет виден.
`maxZoom`	number \| undefined	Максимальный уровень масштаба просмотра (включительно), на котором этот слой будет виден.
`layers`	Array<БазовыйСлой> \| Коллекция<БазовыйСлой> \| undefined	Вложенные слои.
`properties`	Object.<string, *> \| undefined	Произвольные наблюдаемые свойства. Можно получить доступ к ним с помощью `#get()` и `#set()`.

События:

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

Расширяет

БазовыйСлой

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

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`extent`	Extent \| undefined	да	`change:extent`	Граница слоя.
`layers`	Коллекция<БазовыйСлой>	да	`change:layers`	Коллекция `layers`, которые являются частью этой группы.
`maxResolution`	number	да	`change:maxresolution`	Максимальное разрешение слоя.
`maxZoom`	number	да	`change:maxzoom`	Максимальный уровень масштаба слоя.
`minResolution`	number	да	`change:minresolution`	Минимальное разрешение слоя.
`minZoom`	number	да	`change:minzoom`	Минимальный уровень масштаба слоя.
`opacity`	number	да	`change:opacity`	Непрозрачность слоя.
`visible`	boolean	да	`change:visible`	Значение свойства `visible` слоя.
`zIndex`	number \| 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	Имя ключа.

Возвращает:

Значение.

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

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

Возвращает:

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

getKeys(){Array.<string>} inherited Object.js, line 148

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

Возвращает:

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

getLayers(){Collection<BaseLayer>} layer/Group.js, line 256

Возвращает collection layers в этой группе.

Возвращает:

Коллекцию layers, которые являются частью этой группы.

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 164

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

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

Возвращает:

set(key, value, silent) inherited Object.js, строка 215

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

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

setExtent(extent) inherited layer/Base.js, строка 313

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

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

setLayers(layers) layer/Group.js, строка 270

Устанавливает collection layers в этой группе.

Имя	Тип	Описание
`layers`	Collection<BaseLayer>	Коллекция `layers`, которые являются частью этой группы.

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) унаследованный Object.js, строка 235

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

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

setVisible(visible) унаследованный layer/Base.js, строка 378

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