Fullscreen - Cesium Documentation

# Fullscreen

Browser-independent functions for working with the standard fullscreen API.

##### See:

- W3C Fullscreen Living Specification

Source: Core/Fullscreen.js, line 28

### 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 55

#### 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 37

#### 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 88

#### 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 71

#### staticFullscreen.fullscreen :Boolean

  Determines if the browser is currently in fullscreen mode.
  Source: Core/Fullscreen.js, line 103

### 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 241

#### 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 229

#### 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 120