Image~ImageLayer

import ImageLayer from 'ol/layer/Image.js';

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

new ImageLayer(options) layer/Image.js, строка 19

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-layer')	Имя класса CSS, устанавливаемое для элемента слоя.
`opacity`	number (по умолчанию 1)	Непрозрачность (0, 1).
`visible`	boolean (по умолчанию 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	Максимальный уровень масштабирования (включительно), при котором этот слой будет виден.
`map`	Map \| undefined	Устанавливает слой как наложение на карту. Карта не будет управлять этим слоем в своей коллекции слоев, и слой будет отрисовываться поверх. Это полезно для временных слоёв. Стандартный способ добавления слоя на карту и управления им картой — использование `map.addLayer()`.
`source`	ImageSource \| 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)

Расширяет

BaseImageLayer

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

Имя	Тип	Устанавливаемое	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() inherited Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

false, если кто-то вызвал preventDefault в объекте события или если какой-либо из слушателей вернул false.

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

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

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

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

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

Имя	Тип	Описание
`view`	View \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Необходимо только тогда, когда слой не добавлен в карту.

Возвращает:

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

getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null} layer/Image.js, line 50

Получение данных для пикселя. Будет возвращён массив RGBA из четырёх элементов. Для запросов вне области слоя будет возвращено null. Данные изображения могут быть получены только если свойство crossOrigin источника установлено.

// display layer data on every pointer move
map.on('pointermove', (event) => {
  console.log(layer.getData(event.pixel));
});

Имя	Тип	Описание
`pixel`	Pixel	Пиксель.

Возвращает:

Данные пикселя.

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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

Возвращает:

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

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} inherited 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) inherited layer/Layer.js, line 440

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

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

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

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

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

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

setMaxZoom(maxZoom) унаследованный layer/Base.js, строка 345

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

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

setMinResolution(minResolution) унаследованный layer/Base.js, строка 333

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

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

setMinZoom(minZoom) унаследованный layer/Base.js, строка 357

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

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

setOpacity(opacity) унаследованный layer/Base.js, строка 367

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

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

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

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

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

setSource(source) унаследованный layer/Layer.js, строка 488

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

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

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

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

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

setZIndex(zindex) унаследованный layer/Base.js, строка 389

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

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

un(type, listener) унаследованный Observable.js, строка 173

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

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

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

Сбросить свойство.

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