FullscreenControl

Элемент управления FullscreenControl содержит кнопку для переключения карты в полноэкранный режим и обратно. Если requestFullscreen не поддерживается, полноэкранный режим реализуется с помощью свойств CSS. Параметр cooperativeGestures карты временно отключается, пока карта находится в полноэкранном режиме, и восстанавливается при выходе карты из полноэкранного режима.

Параметр

options

параметры элемента управления полноэкранным режимом

Пример

map.addControl(new FullscreenControl({container: document.querySelector('body')}));

См. также

Просмотр карты в полноэкранном режиме

События

Событие fullscreenstart типа FullscreenEvent будет вызвано при включении полноэкранного режима.

Событие fullscreenend типа FullscreenEvent будет вызвано при выходе из полноэкранного режима.

Наследует

Evented<FullscreenControlEventType>

Реализует

IControl

Конструкторы

Конструктор

new FullscreenControl(options?: FullscreenControlOptions): FullscreenControl

Параметры

Параметр	Тип	Описание
`options`	`FullscreenControlOptions`	параметры элемента управления

Возвращает

FullscreenControl

Переопределяет

Evented<FullscreenControlEventType>.constructor

Методы

fire()

Сигнатура вызова

fire(event: FullscreenEvent): this

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

Параметры

Параметр	Тип
`event`	`FullscreenEvent`

Возвращает

this

Унаследовано от

Evented.fire

Сигнатура вызова

fire(type: keyof FullscreenControlEventType, properties?: object): this

Совместимость с сигнатурой (type: string, properties: Object) из предыдущих версий. См. https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Параметры

Параметр	Тип
`type`	keyof `FullscreenControlEventType`
`properties?`	`object`

Возвращает

this

Унаследовано от

Evented.fire

listens()

listens(type: keyof FullscreenControlEventType): boolean

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

Параметры

Параметр	Тип	Описание
`type`	keyof `FullscreenControlEventType`	Тип события

Возвращает

boolean

true, если для указанного типа события зарегистрирован хотя бы один обработчик, и false в противном случае

Унаследовано от

Evented.listens

off()

off<T extends keyof FullscreenControlEventType>(type: T, listener: (event: FullscreenControlEventType[T]) => void): this

Удаляет ранее зарегистрированный обработчик события.

Параметры типа

Параметр типа
`T` extends keyof `FullscreenControlEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, обработчики которого необходимо удалить.
`listener`	(`event`: `FullscreenControlEventType`[`T`]) => `void`	Функция-обработчик, которую необходимо удалить.

Возвращает

this

Унаследовано от

Evented.off

on()

on<T extends keyof FullscreenControlEventType>(type: T, listener: (event: FullscreenControlEventType[T]) => void): Subscription

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

Параметры типа

Параметр типа
`T` extends keyof `FullscreenControlEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, для которого нужно добавить прослушиватель.
`listener`	(`event`: `FullscreenControlEventType`[`T`]) => `void`	Функция, вызываемая при возникновении события. Функция-обработчик вызывается с объектом данных, переданным в `fire`, дополненным свойствами `target` и `type`.

Возвращает

Subscription

Унаследовано от

Evented.on

onAdd()

onAdd(map: Map): HTMLElement

Регистрирует элемент управления на карте и позволяет ему зарегистрировать обработчики событий и ресурсы. Этот метод вызывается внутри Map.addControl.

Параметры

Параметр	Тип	Описание
`map`	`Map`	Карта, на которую будет добавлен этот элемент управления

Возвращает

HTMLElement

Элемент-контейнер элемента управления. Его следует создать в элементе управления и вернуть из onAdd, не добавляя в DOM: при необходимости карта сама вставит элемент управления в DOM.

Реализация

IControl.onAdd

once()

Сигнатура вызова

once<T extends keyof FullscreenControlEventType>(type: T): Promise<FullscreenControlEventType[T]>

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

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

Параметры типа

Параметр типа
`T` extends keyof `FullscreenControlEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, которое нужно прослушивать.

Возвращает

Promise<FullscreenControlEventType[T]>

обещание, которое разрешается объектом события

Унаследовано от

Evented.once

Сигнатура вызова

once<T extends keyof FullscreenControlEventType>(type: T, listener: (event: FullscreenControlEventType[T]) => void): this

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

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

Параметры типа

Параметр типа
`T` extends keyof `FullscreenControlEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, которое нужно прослушивать.
`listener`	(`event`: `FullscreenControlEventType`[`T`]) => `void`	Функция, вызываемая при первом возникновении события.

Возвращает

this

this, если указан обработчик

Унаследовано от

Evented.once

onRemove()

onRemove(): void

Отменяет регистрацию элемента управления на карте и позволяет ему отсоединить обработчики событий и освободить ресурсы. Этот метод вызывается внутри Map.removeControl.

Возвращает

void

Реализация

IControl.onRemove

setEventedParent()

setEventedParent(parent?: Evented<EventTypeMap>, data?: EventedParentData | (() => EventedParentData)): this

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

Параметры

Параметр	Тип
`parent?`	`Evented`<`EventTypeMap`>
`data?`	`EventedParentData` \| (() => `EventedParentData`)

Возвращает

this

Унаследовано от

Evented.setEventedParent

© MapLibre contributors
Licensed under the 3-Clause BSD License.
https://maplibre.org/maplibre-gl-js/docs/API/classes/FullscreenControl/