SwipeViewModel

AMD: require(["esri/widgets/Swipe/SwipeViewModel"], (SwipeViewModel) => { /* code goes here */ });
ESM: import SwipeViewModel from "@arcgis/core/widgets/Swipe/SwipeViewModel";
Class: esri/widgets/Swipe/SwipeViewModel
Inheritance: SwipeViewModel Accessor
Since: ArcGIS API for JavaScript 4.13

Provides the logic for the Swipe widget.

See also

Constructors

new SwipeViewModel(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
String

The name of the class.

more details
Accessor
String

The direction the Swipe widget moves across the view.

more details
SwipeViewModel
Collection<Layer>

A collection of Layers that will show on the left or top side of Swipe widget.

more details
SwipeViewModel
Number

The position of the Swipe widget.

more details
SwipeViewModel
String

The current state of the widget.

more details
SwipeViewModel
Collection<Layer>

A collection of Layers that will show on the right or bottom side of Swipe widget.

more details
SwipeViewModel
MapView

A reference to the MapView.

more details
SwipeViewModel

Property Details

declaredClass Stringreadonly inherited

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

direction 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
widgets-swipe-horizontal widgets-swipe-vertical

Possible Values:"horizontal"|"vertical"

Default Value:"horizontal"
leadingLayers 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. Currently, all layers are supported except GroupLayers.

See also
position 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 Stringreadonly

The current state of the widget.

Possible Values:"disabled"|"ready"

Default Value:disabled
trailingLayers 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. Currently, all layers are supported except GroupLayers.

See also
view MapView

A reference to the MapView. Set this to link the widget to a specific view.

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.

more details
Accessor
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

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: 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);
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.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");

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