BaseImage~BaseImageLayer

import BaseImageLayer from 'ol/layer/BaseImage.js';

Изображения, создаваемые на сервере и доступные для произвольных экстентов и разрешений. Обратите внимание: любое свойство, заданное в параметрах, устанавливается как свойство BaseObject объекта слоя; например, задание title: 'My Title' в параметрах означает, что title является наблюдаемым свойством и имеет методы доступа get/set.

new BaseImageLayer(options) layer/BaseImage.js, строка 49

Имя	Тип	Описание
`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	Максимальный уровень масштабирования вида (включительно), при котором этот слой будет виден.
`map`	Map \| undefined	Устанавливает слой как наложение на карту. Карта не будет управлять этим слоем в своей коллекции слоёв, и слой будет отрисовываться поверх остальных. Это полезно для временных слоёв. Стандартный способ добавить слой на карту, чтобы она управляла им, — использовать `map.addLayer()`.
`source`	ImageSource \| undefined	Источник данных для этого слоя.
`background`	BackgroundColor \| undefined	Цвет фона слоя. Если он не задан, фон не отрисовывается.
`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)

Подклассы

ImageLayer

Расширяет

Layer

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

Имя	Тип	Можно задать	Тип события 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

Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр события может быть строкой или объектом Object со свойством 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	Удаляет свойство без вызова события.