Spec-Zone.ru › OpenLayers

ol/layer/Group~LayerGroup 


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

Collection слоёв, обрабатываемых вместе.

При изменении группы/Collection генерируется общее событие change.

new LayerGroup(options)

layer/Group.js, строка 105
Имя Тип Описание
opacity number (по умолчанию 1)

Непрозрачность (0, 1).
visible boolean (по умолчанию true)

Видимость.
extent Extent | undefined

Ограничивающая область для отображения слоя. За пределами этой области слой отображаться не будет.
zIndex number | undefined

Z-индекс для отображения слоя. При отображении слои упорядочиваются сначала по Z-индексу, а затем по позиции. Если задано undefined, для слоёв, добавленных в коллекцию layers карты, предполагается значение zIndex, а для слоёв, для которых использовался метод setMap(), — Infinity.
minResolution number | undefined

Минимальное разрешение (включительно), при котором этот слой будет видимым.
maxResolution number | undefined

Максимальное разрешение (не включительно), ниже которого этот слой будет видимым.
minZoom number | undefined

Минимальный уровень масштабирования вида (не включительно), выше которого этот слой будет видимым.
maxZoom number | undefined

Максимальный уровень масштабирования вида (включительно), при котором этот слой будет видимым.
layers Array<BaseLayer> | Collection<BaseLayer> | undefined

Дочерние слои.
properties Object.<string, *> | undefined

Произвольные наблюдаемые свойства. Доступ к ним можно получить с помощью #get() и #set().
Генерируемые события:
  • addlayer (GroupEvent) — генерируется при добавлении слоя
  • 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) — генерируется при изменении свойства.
  • removelayer (GroupEvent) — генерируется при удалении слоя

Наследует

  • BaseLayer

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

Имя Тип Можно задать Тип ObjectEvent Описание
extent Extent | undefined да change:extent

Область слоя.
layers Collection<BaseLayer> да 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() унаследовано

Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследовано

events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр события может быть строкой или объектом со свойством type.

Имя Тип Описание
event BaseEvent | string

Объект события.
Возвращает:
false, если кто-либо вызвал preventDefault для объекта события или если любой из обработчиков вернул false.

get(key){*} унаследовано

Object.js, строка 136

Получает значение.

Имя Тип Описание
key string

Имя ключа.
Возвращает:
Значение.

getExtent(){Extent | undefined} унаследовано

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

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

Возвращает:
Экстент слоя.

getKeys(){Array.<string>} унаследовано

Object.js, строка 149

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

Возвращает:
Список имён свойств.

getLayers(){Collection<BaseLayer>}

layer/Group.js, строка 277

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

Возвращает:
Коллекция layers, входящих в эту группу.

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

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

Возвращает:
Номер ревизии.

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

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

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

Возвращает:
Значение свойства visible слоя.

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

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

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

Возвращает:
Z-индекс слоя.

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

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

setLayers(layers)

layer/Group.js, строка 291

Задаёт collection layers этой группы.

Имя Тип Описание
layers Collection<BaseLayer>

Коллекция layers, входящих в эту группу.

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

Обновить без отправки события.

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

Удалить без отправки события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_layer_Group-LayerGroup.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API