ol/Overlay~Overlay

import Overlay from 'ol/Overlay.js';

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

Пример:

import Overlay from 'ol/Overlay.js';

// ...
const popup = new Overlay({
  element: document.getElementById('popup'),
});
popup.setPosition(coordinate);
map.addOverlay(popup);

новый Overlay(options) Overlay.js, строка 112

Имя	Тип	Описание
`id`	число \| строка \| undefined	Устанавливает идентификатор наложения. Идентификатор наложения можно использовать с методом `getOverlayById`.
`element`	HTMLElement \| undefined	Элемент наложения.
`offset`	Массив.<число> (по умолчанию [0, 0])	Смещения в пикселях, используемые при позиционировании наложения. Первый элемент в массиве — горизонтальное смещение. Положительное значение смещает наложение вправо. Второй элемент в массиве — вертикальное смещение. Положительное значение смещает наложение вниз.
`position`	Координата \| undefined	Положение наложения в проекции карты.
`positioning`	Позиционирование (по умолчанию 'top-left')	Определяет, как наложение фактически позиционируется относительно его свойства `position`. Возможные значения: `'bottom-left'`, `'bottom-center'`, `'bottom-right'`, `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`, `'top-center'` и `'top-right'`.
`stopEvent`	логическое значение (по умолчанию true)	Определяет, следует ли останавливать распространение событий в область отображения карты. Если `true`, наложение размещается в том же контейнере, что и контролы (имя класса CSS `ol-overlaycontainer-stopevent`); если `false`, оно размещается в контейнере с именем класса CSS, заданным свойством `className`.
`insertFirst`	логическое значение (по умолчанию true)	Определяет, вставляется ли наложение первым в контейнер наложений или добавляется в конец. Если наложение размещается в том же контейнере, что и контролы (см. опцию `stopEvent`), вы, вероятно, установите `insertFirst` в `true`, чтобы наложение отображалось под контролами.
`autoPan`	ОпцииPanIntoView \| логическое значение (по умолчанию false)	Перемещение карты при вызове `setPosition`, чтобы наложение полностью отображалось в текущем окне просмотра.
`className`	строка (по умолчанию 'ol-overlay-container ol-selectable')	Имя класса CSS.

Вызывает:

change (BaseEvent) — Общее событие изменения. Срабатывает, когда счетчик версий увеличивается.
change:element (ObjectEvent)
change:map (ObjectEvent)
change:offset (ObjectEvent)
change:position (ObjectEvent)
change:positioning (ObjectEvent)
error (BaseEvent) — Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) — Срабатывает при изменении свойства.

Расширяет

BaseObject

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

Имя	Тип	Можно устанавливать?	ObjectEvent тип	Описание
`element`	HTMLElement \| undefined	да	`change:element`	Элемент, содержащий наложение.
`map`	Карта \| null	да	`change:map`	Карта, частью которой является наложение.
`offset`	Массив.<число>	да	`change:offset`	Смещение.
`position`	Координата \| undefined	да	`change:position`	Пространственная точка, к которой привязано наложение.
`positioning`	Позиционирование	да	`change:positioning`	Как наложение позиционируется относительно точки на карте.

Методы

changed() унаследованно Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследованно events/Target.js, строка 85

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

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

Возвращает:

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

get(key){*} унаследованно Object.js, строка 135

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

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

Возвращает:

Значение.

getElement(){HTMLElement | undefined} Overlay.js, строка 218

Получить DOM-элемент этого наложения.

Возвращает:

Элемент, содержащий наложение.

getId(){number | string | undefined} Overlay.js, строка 227

Получить идентификатор наложения, установленный при создании.

Возвращает:

Идентификатор.

getKeys(){Array.<string>} унаследованно Object.js, строка 148

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

Возвращает:

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

getMap(){Карта | null} Overlay.js, строка 238

Получить карту, связанную с этим наложением.

Возвращает:

Карту, частью которой является наложение.

getOffset(){Array.<number>} Overlay.js, строка 250

Получить смещение этого наложения.

Возвращает:

Смещение.

getPosition(){Координата | undefined} Overlay.js, строка 261

Получить текущую позицию этого наложения.

Возвращает:

Пространственную точку, к которой привязано наложение.

getPositioning(){Позиционирование} Overlay.js, строка 274

Получить текущее позиционирование этого наложения.

Возвращает:

Способ позиционирования наложения относительно точки на карте.

getProperties(){Object.<string, *>} унаследованно Object.js, строка 157

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

Возвращает:

Объект.

getRevision(){number} унаследованно Observable.js, строка 79

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

Возвращает:

Ревизия.

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	Функция-обработчик.

Возвращает:

panIntoView(panIntoViewOptions) Overlay.js, line 408

Переместить карту так, чтобы наложение полностью отображалось в текущем окне просмотра (при необходимости).

Name Type Description

panIntoViewOptions

Параметры для действия панорамирования

Name	Type	Description
`animation`	PanOptions (defaults to {})	Параметры анимации для панорамирования
`margin`	number (defaults to 20)	Поле (в пикселях) между наложением и границами карты при панорамировании в поле зрения.

set(key, value, silent) inherited Object.js, line 215

Устанавливает значение.

Name	Type	Description
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновление без вызова события.

setElement(element) Overlay.js, line 354

Устанавливает DOM-элемент, который будет связан с этим наложением.

Name	Type	Description
`element`	HTMLElement \| undefined	Элемент, содержащий наложение.

setMap(map) Overlay.js, line 365

Устанавливает карту, которая будет связана с этим наложением.

Name	Type	Description
`map`	Map \| null	Карта, частью которой является наложение. Передайте `null`, чтобы просто удалить наложение с текущей карты.

setOffset(offset) Overlay.js, line 375

Устанавливает смещение для этого наложения.

Name	Type	Description
`offset`	Array.<number>	Смещение.

setPosition(position) Overlay.js, line 387

Устанавливает позицию для этого наложения. Если позиция undefined, наложение скрыто.

Name	Type	Description
`position`	Coordinate \| undefined	Пространственная точка, к которой привязывается наложение.

setPositioning(positioning) Overlay.js, line 490

Устанавливает позиционирование для этого наложения.

Name	Type	Description
`positioning`	Positioning	как наложение позиционируется относительно своей точки на карте.

setProperties(values, silent) inherited Object.js, line 235

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

Name	Type	Description
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновление без вызова события.

un(type, listener) inherited Observable.js, line 173

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

Name	Type	Description
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция прослушивателя.

unset(key, silent) inherited Object.js, line 259

Сбрасывает свойство.

Name	Type	Description
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Сброс без вызова события.