BaseImage~БазовыйИзображениеСлои

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

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

НовыйБазовыйИзображениеСлои(options) layer/BaseImage.js, строка 47

Имя	Тип	Описание
`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	Максимальный уровень масштаба просмотра (включительно), при котором этот слой будет отображаться.
`map`	Карта \| undefined	Устанавливает слой как наложение на карту. Карта не будет управлять этим слоем в своей коллекции слоев, и слой будет отображаться поверх. Это полезно для временных слоев. Стандартный способ добавления слоя на карту и управления им картой — использование `map.addLayer()`.
`source`	ИсточникИзображения \| undefined	Источник для этого слоя.
`properties`	Объект.<строка, *> \| undefined	Произвольные наблюдаемые свойства. Можно получить доступ с помощью `#get()` и `#set()`.

События:

change (БазовоеСобытие) — Общее событие изменения. Срабатывает, когда счётчик ревизии увеличивается.
change:extent (ОбъектноеСобытие)
change:maxResolution (ОбъектноеСобытие)
change:maxZoom (ОбъектноеСобытие)
change:minResolution (ОбъектноеСобытие)
change:minZoom (ОбъектноеСобытие)
change:opacity (ОбъектноеСобытие)
change:source (ОбъектноеСобытие)
change:visible (ОбъектноеСобытие)
change:zIndex (ОбъектноеСобытие)
error (БазовоеСобытие) — Общее событие об ошибке. Срабатывает при возникновении ошибки.
postrender (СобытиеОтрисовки) — Срабатывает после отрисовки слоя.
prerender (СобытиеОтрисовки) — Срабатывает перед отрисовкой слоя.
propertychange (ОбъектноеСобытие) — Срабатывает при изменении свойства.
sourceready (БазовоеСобытие)

Подклассы

ИзображениеСлои

Расширяет

Слои

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

Имя	Тип	Устанавливаемое	ОбъектноеСобытие тип	Описание
`extent`	Область \| undefined	да	`change:extent`	Область слоя.
`maxResolution`	число	да	`change:maxresolution`	Максимальное разрешение слоя.
`maxZoom`	число	да	`change:maxzoom`	Максимальный уровень масштаба слоя.
`minResolution`	число	да	`change:minresolution`	Минимальное разрешение слоя.
`minZoom`	число	да	`change:minzoom`	Минимальный уровень масштаба слоя.
`opacity`	число	да	`change:opacity`	Непрозрачность слоя.
`source`	ТипИсточника \| 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.

Имя	Тип	Описание
`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`. Необходимо только когда слой не добавлен в карту.

Возвращаемое значение:

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

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) inherited layer/Base.js, line 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	Удалить без срабатывания события.