# Class: FullScreen

This documentation is for OpenLayers v10.9.0. The latest is v.

## ol/control/FullScreen~FullScreen

    import FullScreen from 'ol/control/FullScreen.js';

Provides a button that when clicked fills up the full screen with the map. The full screen source element is by default the element containing the map viewport unless overridden by providing the `source` option. In which case, the dom element introduced using this parameter will be displayed in full screen.

When in full screen mode, a close button is shown to exit full screen mode. The Fullscreen API is used to toggle the map in full screen mode.

#### new FullScreen(options)

control/FullScreen.js, line 77

  Name | Type | Description
  --- | --- | ---
  `className` | string (defaults to 'ol-full-screen') | CSS class name.
  `label` | string | Text | HTMLElement (defaults to '\u2922') | Text label to use for the button. Instead of text, also an element (e.g. a `span` element) can be used.
  `labelActive` | string | Text | HTMLElement (defaults to '\u00d7') | Text label to use for the button when full-screen is active. Instead of text, also an element (e.g. a `span` element) can be used.
  `activeClassName` | string (defaults to className + '-true') | CSS class name for the button when full-screen is active.
  `inactiveClassName` | string (defaults to className + '-false') | CSS class name for the button when full-screen is inactive.
  `tipLabel` | string (defaults to 'Toggle full-screen') | Text label to use for the button tip.
  `keys` | boolean (defaults to false) | Full keyboard access.
  `target` | HTMLElement | string | undefined | Specify a target if you want the control to be rendered outside of the map's viewport.
  `source` | HTMLElement | string | undefined | The element to be displayed fullscreen. When not provided, the element containing the map viewport will be displayed fullscreen.

  ##### Fires:

  - `change` (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
  - `enterfullscreen` - Triggered after the map entered fullscreen.
  - `error` (BaseEvent) - Generic error event. Triggered when an error occurs.
  - `leavefullscreen` - Triggered after the map leave fullscreen.
  - `propertychange` (ObjectEvent) - Triggered when a property is changed.

### Extends

- Control

### Methods

#### changed() inherited

Observable.js, line 68

  Increases the revision counter and dispatches a 'change' event.

#### dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

  Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a `type` property.

  Name | Type | Description
  --- | --- | ---
  `event` | BaseEvent | string | Event object.

  ##### Returns:

  `false` if anyone called preventDefault on the event object or if any of the listeners returned false.

#### get(key){*} inherited

Object.js, line 136

  Gets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.

  ##### Returns:

  Value.

#### getKeys(){Array.<string>} inherited

Object.js, line 149

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getMap(){Map | null} inherited

control/Control.js, line 104

  Get the map associated with this control.

  ##### Returns:

  Map.

#### getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

  Get an object of all property names and values.

  ##### Returns:

  Object.

#### getRevision(){number} inherited

Observable.js, line 79

  Get the version number for this object. Each time the object is modified, its version number will be incremented.

  ##### Returns:

  Revision.

#### on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

  Listen for a certain type of event.

  Name | Type | Description
  --- | --- | ---
  `type` | string | Array.<string> | The event type or array of event types.
  `listener` | function | The listener function.

  ##### Returns:

  Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

#### once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

  Listen once for a certain type of event.

  Name | Type | Description
  --- | --- | ---
  `type` | string | Array.<string> | The event type or array of event types.
  `listener` | function | The listener function.

  ##### Returns:

  Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

#### render(mapEvent) inherited

control/Control.js, line 144

  Renders the control.

  Name | Type | Description
  --- | --- | ---
  `mapEvent` | MapEvent | Map event.

#### set(key, value, silent) inherited

Object.js, line 218

  Sets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.
  `value` | * | Value.
  `silent` | boolean | undefined | Update without triggering an event.

#### setMap(map)

control/FullScreen.js, line 288

  Remove the control from its current map and attach it to the new map. Pass `null` to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.

  Name | Type | Description
  --- | --- | ---
  `map` | Map | null | Map.

#### setProperties(values, silent) inherited

Object.js, line 238

  Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

  Name | Type | Description
  --- | --- | ---
  `values` | Partial.<NoInfer.<Properties>> | Values.
  `silent` | boolean | undefined | Update without triggering an event.

#### setTarget(target) inherited

control/Control.js, line 155

  This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after `setMap` is called on the control). If no `target` is set in the options passed to the control constructor and if `setTarget` is not called then the control is added to the map's overlay container.

  Name | Type | Description
  --- | --- | ---
  `target` | HTMLElement | string | Target.

#### un(type, listener) inherited

Observable.js, line 173

  Unlisten for a certain type of event.

  Name | Type | Description
  --- | --- | ---
  `type` | string | Array.<string> | The event type or array of event types.
  `listener` | function | The listener function.

#### unset(key, silent) inherited

Object.js, line 262

  Unsets a property.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.
  `silent` | boolean | undefined | Unset without triggering an event.