Fullscreen

Members

staticFullscreen.changeEventName :String

The name of the event on the document that is fired when fullscreen is entered or exited. This event name is intended for use with addEventListener. In your event handler, to determine if the browser is in fullscreen mode or not, use Fullscreen#fullscreen.

Source: Core/Fullscreen.js, line 54

staticFullscreen.element :Object

The element that is currently fullscreen, if any. To simply check if the browser is in fullscreen mode or not, use Fullscreen#fullscreen.

Source: Core/Fullscreen.js, line 36

staticFullscreen.enabled :Boolean

Determine whether the browser will allow an element to be made fullscreen, or not. For example, by default, iframes cannot go fullscreen unless the containing page adds an "allowfullscreen" attribute (or prefixed equivalent).

Source: Core/Fullscreen.js, line 87

staticFullscreen.errorEventName :String

The name of the event that is fired when a fullscreen error occurs. This event name is intended for use with addEventListener.

Source: Core/Fullscreen.js, line 70

Methods

staticFullscreen.exitFullscreen()

Asynchronously exits fullscreen mode. If the browser is not currently in fullscreen, or if fullscreen mode is not supported by the browser, does nothing.

Source: Core/Fullscreen.js, line 240

staticFullscreen.requestFullscreen(element)

Asynchronously requests the browser to enter fullscreen mode on the given element. If fullscreen mode is not supported by the browser, does nothing.

Name	Type	Description
element	Object	The HTML element which will be placed into fullscreen mode.

Example:

// Put the entire page into fullscreen.
Cesium.Fullscreen.requestFullscreen(document.body)

// Place only the Cesium canvas into fullscreen.
Cesium.Fullscreen.requestFullscreen(scene.canvas)

Source: Core/Fullscreen.js, line 228

staticFullscreen.supportsFullscreen()

Detects whether the browser supports the standard fullscreen API.

Returns:

true if the browser supports the standard fullscreen API, false otherwise.

Source: Core/Fullscreen.js, line 119