OverviewMap~OverviewMap

import OverviewMap from 'ol/control/OverviewMap.js';

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

new OverviewMap(options) control/OverviewMap.js, строка 67

Имя	Тип	Описание
`className`	строка (по умолчанию 'ol-overviewmap')	Имя класса CSS.
`collapsed`	логическое значение (по умолчанию true)	Должен ли элемент управления начинаться в сложенном или не сложенном (развернутом) состоянии?
`collapseLabel`	строка \| HTMLElement (по умолчанию '‹')	Текст метки для развернутой кнопки "обзорная карта". Вместо текста также можно использовать элемент (например, элемент `span`).
`collapsible`	логическое значение (по умолчанию true)	Можно ли сложить элемент управления?
`label`	строка \| HTMLElement (по умолчанию '›')	Текст метки для сложенной кнопки "обзорная карта". Вместо текста также можно использовать элемент (например, элемент `span`).
`layers`	Массив<БазовыйСлой> \| Коллекция<БазовыйСлой> \| undefined	Слои для обзорной карты.
`render`	функция \| undefined	Функция, вызываемая, когда элемент управления должен быть повторно отрисован. Она вызывается в коллбэке `requestAnimationFrame`.
`rotateWithView`	логическое значение (по умолчанию false)	Должен ли вид элемента управления поворачиваться вместе с основным видом карты?
`target`	HTMLElement \| строка \| undefined	Укажите целевой элемент, если вы хотите отобразить элемент управления вне области просмотра карты.
`tipLabel`	строка (по умолчанию 'Обзорная карта')	Текст метки, используемой для подсказки кнопки.
`view`	Вид \| undefined	Настраиваемый вид для обзорной карты (должен использовать ту же проекцию, что и основная карта). Если не указано, будет использоваться вид по умолчанию с той же проекцией, что и основная карта.

Вызывает:

change (БазовоеСобытие) - Общее событие изменения. Вызывается, когда счетчик изменений увеличивается.
error (БазовоеСобытие) - Общее событие ошибки. Вызывается, когда возникает ошибка.
propertychange (ОбъектноеСобытие) - Вызывается при изменении свойства.

Расширяет

Control

Методы

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	Имя ключа.

Возвращает:

Значение.

getCollapsed(){boolean} control/OverviewMap.js, line 629

Определяет, свёрнута ли карта обзора.

Возвращает:

Свёрнута ли карта обзора.

getCollapsible(){boolean} control/OverviewMap.js, line 590

Возвращает true, если карта обзора свёртывается, false в противном случае.

Возвращает:

Истинно, если виджет свёртывается.

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

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

Возвращает:

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

getMap(){Map | null} inherited control/Control.js, line 104

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

Возвращает:

Карту.

getOverviewMap(){Map} control/OverviewMap.js, line 669

Возвращает карту обзора.

Возвращает:

Карту обзора.

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

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

Возвращает:

Объект.

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

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

Возвращает:

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

getRotateWithView(){boolean} control/OverviewMap.js, line 638

Возвращает true, если карта обзора может поворачиваться, false в противном случае.

Возвращает:

Истинно, если вид вращения элемента управления включён.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

Подписаться на определённый тип события.

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

Подписаться один раз на определённый тип события.

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

Возвращает:

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

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

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

setCollapsed(collapsed) control/OverviewMap.js, строка 617

Сворачивает или разворачивает карту обзора в зависимости от переданного параметра. Ничего не сделает, если карта обзора не может быть свернута или если текущее состояние свёрнутости уже такое, какое требуется.

Имя	Тип	Описание
`collapsed`	boolean	Истина, если виджет свёрнут.

setCollapsible(collapsible) control/OverviewMap.js, строка 599

Установить, должна ли карта обзора быть сворачиваемой.

Имя	Тип	Описание
`collapsible`	boolean	Истина, если виджет сворачивается.

setMap(map) control/OverviewMap.js, строка 277

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

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

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

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

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

setRotateWithView(rotateWithView) control/OverviewMap.js, строка 647

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

Имя	Тип	Описание
`rotateWithView`	boolean	Истина, если представление элемента управления должно поворачиваться.

setTarget(target) унаследованный control/Control.js, строка 155

Эта функция используется для установки целевого элемента для элемента управления. Она не имеет эффекта, если вызывается после добавления элемента управления на карту (т. е. после вызова setMap на элементе управления). Если в опциях, переданных конструктору элемента управления, не задан target и если не был вызван setTarget, то элемент управления добавляется в контейнер наложения карты.

Имя	Тип	Описание
`target`	HTMLElement \| string	Цель.

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

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

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

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

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

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