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 and component.
- See also
-
Swipe widget - Deprecated since 4.32. Use the Swipe component instead.
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 |
---|---|---|---|
The name of the class. | Accessor | ||
The direction the Swipe moves across the view. | SwipeViewModel | ||
A collection of Layers that will show on the left or top side of the Swipe. | SwipeViewModel | ||
The maximum position of the Swipe, as a percentage. | SwipeViewModel | ||
The minimum position of the Swipe, as a percentage. | SwipeViewModel | ||
The position of the Swipe. | SwipeViewModel | ||
The current state of the Swipe. | SwipeViewModel | ||
The step value used to increment or decrement the position of the Swipe when using keyboard navigation. | SwipeViewModel | ||
The multiplier used to increase the step value when the | SwipeViewModel | ||
A collection of Layers that will show on the right or bottom side of the Swipe. | SwipeViewModel | ||
A reference to the MapView. | SwipeViewModel |
Property Details
-
direction
direction String
-
The direction the Swipe moves across the view. If
"horizontal"
, it will move left and right and if"vertical"
, it will move up and down.Possible Values:"horizontal" |"vertical"
- Default Value:"horizontal"
-
leadingLayers
leadingLayers Collection<Layer>autocast
-
A collection of Layers that will show on the left or top side of the Swipe. See the image in the Swipe class description.
- See also
-
max
max Numberreadonly
Since: ArcGIS Maps SDK for JavaScript 4.32SwipeViewModel since 4.13, max added at 4.32. -
The maximum position of the Swipe, as a percentage.
- Default Value:100
-
min
min Numberreadonly
Since: ArcGIS Maps SDK for JavaScript 4.32SwipeViewModel since 4.13, min added at 4.32. -
The minimum position of the Swipe, as a percentage.
- Default Value:0
-
position
position Number
-
The position of the Swipe. This determines what percentage of the view will be taken up by the leadingLayers.
- Default Value:25
-
state
state Stringreadonly
-
The current state of the Swipe.
Possible Values:"disabled" |"ready"
- Default Value:"disabled"
-
step
step Number
Since: ArcGIS Maps SDK for JavaScript 4.32SwipeViewModel since 4.13, step added at 4.32. -
The step value used to increment or decrement the position of the Swipe when using keyboard navigation.
- Default Value:0.5
-
trailingLayers
trailingLayers Collection<Layer>autocast
-
A collection of Layers that will show on the right or bottom side of the Swipe. See the image in the Swipe class description.
- See also
-
A reference to the MapView. Set this to link the Swipe to a specific view.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
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 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"); }
-
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");