FullScreen~FullScreen

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

Предоставляет кнопку, которая при нажатии заполняет весь экран картой. По умолчанию элементом для полноэкранного отображения является элемент, содержащий область просмотра карты, если не задан параметр source. В этом случае, элемент DOM, указанный в этом параметре, будет отображен в полноэкранном режиме.

В полноэкранном режиме отображается кнопка закрытия для выхода из полноэкранного режима. Для переключения карты в полноэкранный режим используется API Fullscreen API.

new FullScreen(options) control/FullScreen.js, line 77

Имя	Тип	Описание
`className`	string (defaults to 'ol-full-screen')	Имя CSS-класса.
`label`	string \| Text \| HTMLElement (defaults to '\u2922')	Текст метки для кнопки. Вместо текста также может быть использован элемент (например, `span` элемент).
`labelActive`	string \| Text \| HTMLElement (defaults to '\u00d7')	Текст метки для кнопки, когда активен полноэкранный режим. Вместо текста также может быть использован элемент (например, `span` элемент).
`activeClassName`	string (defaults to className + '-true')	Имя CSS-класса для кнопки, когда активен полноэкранный режим.
`inactiveClassName`	string (defaults to className + '-false')	Имя CSS-класса для кнопки, когда полноэкранный режим неактивен.
`tipLabel`	string (defaults to 'Toggle full-screen')	Текст метки для подсказки кнопки.
`keys`	boolean (defaults to false)	Полный доступ с клавиатуры.
`target`	HTMLElement \| string \| undefined	Укажите целевой элемент, если вы хотите отобразить элемент управления вне области просмотра карты.
`source`	HTMLElement \| string \| undefined	Элемент, который будет отображен в полноэкранном режиме. Если не указано, элемент, содержащий область просмотра карты, будет отображен в полноэкранном режиме.

Срабатывает:

change (BaseEvent) - Общее событие изменения. Срабатывает, когда счетчик изменений увеличивается.
enterfullscreen - Срабатывает после перехода карты в полноэкранный режим.
error (BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки.
leavefullscreen - Срабатывает после выхода карты из полноэкранного режима.
propertychange (ObjectEvent) - Срабатывает при изменении свойства.

Расширяет

Control

Методы

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

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

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

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

Возвращает:

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

getMap(){Карта | null} унаследованный control/Control.js, строка 104

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

Возвращает:

Карта.

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

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

Возвращает:

Объект.

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

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

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 164

Прослушать событие определённого типа один раз.

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

Возвращает:

render(mapEvent) унаследованный control/Control.js, строка 144

Отображает элемент управления.

Имя	Тип	Описание
`mapEvent`	MapEvent	Событие карты.

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

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

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

setMap(map) control/FullScreen.js, строка 288

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

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

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

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

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

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

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

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

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

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

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

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

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

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