FullscreenControl

Defined in: ui/control/fullscreen_control.ts:76

A FullscreenControl control contains a button for toggling the map in and out of fullscreen mode. When requestFullscreen is not supported, fullscreen is handled via CSS properties. The map's cooperativeGestures option is temporarily disabled while the map is in fullscreen mode, and is restored when the map exist fullscreen mode.

Param

options

the full screen control options

Example

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

See

View a fullscreen map

Events

Event fullscreenstart of type FullscreenEvent will be fired when fullscreen mode has started.

Event fullscreenend of type FullscreenEvent will be fired when fullscreen mode has ended.

Extends

Evented<FullscreenControlEventType>

Implements

IControl

Constructors

Constructor

new FullscreenControl(options?: FullscreenControlOptions): FullscreenControl

Defined in: ui/control/fullscreen_control.ts:89

Parameters

Parameter	Type	Description
`options`	`FullscreenControlOptions`	the control's options

Returns

FullscreenControl

Overrides

Evented<FullscreenControlEventType>.constructor

Methods

listens()

listens(type: string): boolean

Defined in: util/evented.ts:180

Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

Parameters

Parameter	Type	Description
`type`	`string`	The event type

Returns

boolean

true if there is at least one registered listener for specified event type, false otherwise

Inherited from

Evented.listens

off()

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

Defined in: util/evented.ts:95

Removes a previously registered event listener.

Type Parameters

Type Parameter
`T` extends keyof `FullscreenControlEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to remove listeners for.
`listener`	(`event`: `FullscreenControlEventType`[`T`]) => `void`	The listener function to remove.

Returns

this

Inherited from

Evented.off

on()

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

Defined in: util/evented.ts:78

Adds a listener to a specified event type.

Type Parameters

Type Parameter
`T` extends keyof `FullscreenControlEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to add a listen for.
`listener`	(`event`: `FullscreenControlEventType`[`T`]) => `void`	The function to be called when the event is fired. The listener function is called with the data object passed to `fire`, extended with `target` and `type` properties.

Returns

Subscription

Inherited from

Evented.on

onAdd()

onAdd(map: Map): HTMLElement

Defined in: ui/control/fullscreen_control.ts:114

Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map.addControl internally.

Parameters

Parameter	Type	Description
`map`	`Map`	the Map this control will be added to

Returns

HTMLElement

The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.

Implementation of

IControl.onAdd

once()

Call Signature

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

Defined in: util/evented.ts:110

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Type Parameters

Type Parameter
`T` extends keyof `FullscreenControlEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to listen for.

Returns

Promise<FullscreenControlEventType[T]>

a promise that resolves with the event

Inherited from

Evented.once

Call Signature

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

Defined in: util/evented.ts:120

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Type Parameters

Type Parameter
`T` extends keyof `FullscreenControlEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to listen for.
`listener`	(`event`: `FullscreenControlEventType`[`T`]) => `void`	The function to be called when the event is fired the first time.