Class 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: 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 Event will be fired when fullscreen mode has started.

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

Hierarchy (view full)

Implements

Constructors

constructor

Methods

listens off on onAdd onRemove once setEventedParent

Constructors

constructor

Methods

listens

  • listens(type): boolean

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

    Parameters

    • type: string

      The event type

    Returns boolean

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

off

on

  • on(type, listener): this

  • Adds a listener to a specified event type.

    Parameters

    • 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

onAdd

  • onAdd(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

    • 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.

onRemove

  • onRemove(): void

  • Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map#removeControl internally.

    Returns void

once

  • once(type, listener?): Promise<any> | FullscreenControl

  • 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.

    Parameters

    • type: string

      The event type to listen for.

    • Optional listener: Listener

      The function to be called when the event is fired the first time.

    Returns Promise<any> | FullscreenControl

    this or a promise if a listener is not provided

setEventedParent

Settings

Member Visibility

Theme

On This Page

constructorlistensoffononAddonRemoveoncesetEventedParent