Layer~Слой

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

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

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

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

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

Новый Слой(options) layer/Layer.js, строка 100

Имя	Тип	Описание
`className`	строка (по умолчанию 'ol-layer')	Имя CSS-класса для слоя.
`opacity`	число (по умолчанию 1)	Непрозрачность (0, 1).
`visible`	логическое (по умолчанию true)	Видимость.
`extent`	Область \| undefined	Границы отображения слоя. Слой не будет отображаться за пределами этой области.
`zIndex`	число \| undefined	Индекс Z для отображения слоя. Во время отображения слои упорядочиваются сначала по индексу Z, а затем по положению. Если `undefined`, для слоёв, добавленных в коллекцию `layers` карты, предполагается значение индекса Z равное 0, или `Infinity`, если использовалась функция `setMap()` слоя.
`minResolution`	число \| undefined	Минимальное разрешение (включительно), при котором этот слой будет виден.
`maxResolution`	число \| undefined	Максимальное разрешение (исключительно), ниже которого этот слой не будет виден.
`minZoom`	число \| undefined	Минимальный уровень масштаба просмотра (исключительно) выше которого этот слой будет виден.
`maxZoom`	число \| undefined	Максимальный уровень масштаба просмотра (включительно), при котором этот слой будет виден.
`source`	SourceType \| undefined	Источник для этого слоя. Если не указан в конструкторе, источник можно установить, вызвав `layer.setSource(source)` после построения.
`map`	Карта \| null \| undefined	Карта.
`render`	Функция отрисовки \| undefined	Функция отрисовки. Принимает состояние кадра в качестве входных данных и должна возвращать HTML-элемент. Заменяет стандартную отрисовку слоя.
`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)

Подклассы

Расширяет

БазовыйСлой

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

Имя	Тип	Устанавливаемое	Тип ObjectEvent	Описание
`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.

Name	Type	Description
`event`	BaseEvent \| string	Объект события.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 135

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

Name	Type	Description
`key`	string	Имя ключа.

Returns:

Value.

getAttributions(view){Array.<string>} layer/Layer.js, line 345

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

Name	Type	Description
`view`	View \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Требуется только тогда, когда слой не добавлен на карту.

Returns:

Attributions for this layer at the given view.

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

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

Returns:

The layer extent.

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

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

Returns:

List of property names.

getMaxResolution(){number} inherited layer/Base.js, line 220

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

Returns:

The maximum resolution of the layer.

getMaxZoom(){number} inherited layer/Base.js, line 253

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

Returns:

The maximum zoom level of the layer.

getMinResolution(){number} inherited layer/Base.js, line 231

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

Returns:

The minimum resolution of the layer.

getMinZoom(){number} inherited layer/Base.js, line 242

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

Returns:

The minimum zoom level of the layer.

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

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

Returns:

The opacity of the layer.

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

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

Returns:

Object.

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

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

Returns:

Revision.

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

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

Returns:

The layer source (or null if not yet set).

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

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

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

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

setMap(map) layer/Layer.js, line 440

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

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

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

setMaxResolution(maxResolution) inherited layer/Base.js, line 323

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

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

setMaxZoom(maxZoom) inherited layer/Base.js, line 345

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

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

установитьМинимальноеРазрешение(minResolution) унаследованное layer/Base.js, строка 333

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

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

установитьМинимальныйМасштаб(minZoom) унаследованное layer/Base.js, строка 357

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

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

установитьНепрозрачность(opacity) унаследованное layer/Base.js, строка 367

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

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

установитьСвойства(values, silent) унаследованное Object.js, строка 235

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

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

установитьИсточник(source) layer/Layer.js, строка 488

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

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

установитьВидимость(visible) унаследованное layer/Base.js, строка 378

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

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

установитьИндексZ(zindex) унаследованное layer/Base.js, строка 389

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

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

отписаться(type, listener) унаследованное Observable.js, строка 173

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

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

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

Удаляет свойство.

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