Provides the logic for the Fullscreen widget.
Constructors
-
new FullscreenViewModel(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. more details | Accessor | |
| HTMLElement | The HTMLElement to present in fullscreen mode. more details | FullscreenViewModel | |
| String | The view model's state. more details | FullscreenViewModel | |
| MapView|SceneView | The view associated with the widget instance. more details | FullscreenViewModel |
Property Details
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
element HTMLElement
-
The HTMLElement to present in fullscreen mode.
-
state Stringreadonly
-
The view model's state.
Possible Values:"active"|"ready"|"feature-unsupported"|"disabled"
- Default Value:disabled
-
The view associated with the widget instance.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Enter fullscreen more details | FullscreenViewModel | ||
Exit fullscreen more details | FullscreenViewModel | ||
| Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Toggle fullscreen more details | FullscreenViewModel |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS API for JavaScript 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 } ); // Handle gets removed when the object is destroyed. this.addHandles(handle);ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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()
-
Enter fullscreen
-
exit()
-
Exit fullscreen
-
Since: ArcGIS API for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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(groupKey)inheritedSince: ArcGIS API for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toggle()
-
Toggle fullscreen