require(["esri/widgets/Swipe/SwipeViewModel"], (SwipeViewModel) => { /* code goes here */ });
import SwipeViewModel from "@arcgis/core/widgets/Swipe/SwipeViewModel.js";
esri/widgets/Swipe/SwipeViewModel
Provides the logic for the Swipe widget.
Constructors
-
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. | Accessor | |
| String | The direction the Swipe widget moves across the view. | SwipeViewModel | |
| Collection<Layer> | A collection of Layers that will show on the left or top side of Swipe widget. | SwipeViewModel | |
| Number | The position of the Swipe widget. | SwipeViewModel | |
| String | The current state of the widget. | SwipeViewModel | |
| Collection<Layer> | A collection of Layers that will show on the right or bottom side of Swipe widget. | SwipeViewModel | |
| MapView | A reference to the MapView. | SwipeViewModel |
Property Details
-
direction
Propertydirection String -
The direction the Swipe widget moves across the view. If
"horizontal", the widget will move left and right and if"vertical", the widget will move up and down.horizontal vertical 
Possible Values:"horizontal"|"vertical"
- Default Value:"horizontal"
-
leadingLayers
PropertyleadingLayers Collection<Layer>autocast -
A collection of Layers that will show on the left or top side of Swipe widget. See the image in the Swipe class description.
- See also
-
position
Propertyposition Number -
The position of the Swipe widget. This determines what percentage of the view will be taken up by the leadingLayers.
- Default Value:25
-
state
Propertystate Stringreadonly -
The current state of the widget.
Possible Values:"disabled"|"ready"
- Default Value:disabled
-
trailingLayers
PropertytrailingLayers Collection<Layer>autocast -
A collection of Layers that will show on the right or bottom side of Swipe widget. See the image in the Swipe class description.
- See also
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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");