FullscreenControl

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

the full screen control options

Example

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

See

View a fullscreen map

Events

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

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

Extends

Evented

Implements

IControl

Constructors

new FullscreenControl()

new FullscreenControl(options: FullscreenControlOptions): FullscreenControl

Parameters

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

Returns

FullscreenControl

Overrides

Evented.constructor

Defined in

src/ui/control/fullscreen_control.ts:52

Methods

listens()

listens(type: string): boolean

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

Defined in

src/util/evented.ts:161

off()

off(type: string, listener: Listener): FullscreenControl

Removes a previously registered event listener.

Parameters

Parameter	Type	Description
`type`	`string`	The event type to remove listeners for.
`listener`	`Listener`	The listener function to remove.

on()

on(type: string, listener: Listener): this

Adds a listener to a specified event type.

Parameters

Parameter	Type	Description
`type`	`string`	The event type to add a listen for.
`listener`	`Listener`	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

this

Inherited from

Evented.on

Defined in

src/util/evented.ts:73

onAdd()

onAdd(map: Map): HTMLElement

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.