FullscreenViewModel

AMD: require(["esri/widgets/Fullscreen/FullscreenViewModel"], (FullscreenVM) => { /* code goes here */ });
ESM: import FullscreenVM from "@arcgis/core/widgets/Fullscreen/FullscreenViewModel.js";
Class: esri/widgets/Fullscreen/FullscreenViewModel
Inheritance: FullscreenViewModel Accessor
Since: ArcGIS Maps SDK for JavaScript 4.6

Provides the logic for the Fullscreen widget.

See also

Constructors

FullscreenViewModel

Constructor
new FullscreenViewModel(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

The HTMLElement to present in fullscreen mode.

FullscreenViewModel

The view model's state.

FullscreenViewModel

The view associated with the widget instance.

FullscreenViewModel

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

element

Property
element HTMLElement

The HTMLElement to present in fullscreen mode.

state

Property
state Stringreadonly

The view model's state.

Possible Values:"active" |"ready" |"feature-unsupported" |"disabled"

Default Value:disabled

view

Property
view MapView |SceneView

The view associated with the widget instance.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Enter fullscreen

FullscreenViewModel

Exit fullscreen

FullscreenViewModel

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Toggle fullscreen

FullscreenViewModel

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

enter

Method
enter()

Enter fullscreen

exit

Method
exit()

Exit fullscreen

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toggle

Method
toggle()

Toggle fullscreen

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.