Swipe

The Swipe widget provides a tool to show a portion of a layer or layers on top of a map. Layers can be swiped vertically or horizontally to easily compare two layers or see what is underneath a layer.

To use the Swipe widget, set the leadingLayers and trailingLayers properties to determine what will be compared on either side of the widget. If one of these properties is not set, then the Swipe widget will overlay the existing map. The visibleElements separate the leading and trailing layers, as shown in the image below.

Known Limitations

This widget is not currently supported with a SceneView.
There is no current support for GroupLayer in the leadingLayers or trailingLayers.

See also

Example

let swipe = new Swipe({
  view: view,
  leadingLayers: [layer1, layer2],
  trailingLayers: [layer3],
  direction: "vertical", // swipe widget will move from top to bottom of view
  position: 50 // position set to middle of the view (50%)
});
view.ui.add(swipe);

Constructors

new Swipe(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

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	Widget
String	The name of the class. more details	Accessor
String	The direction the Swipe widget moves across the view. more details	Swipe
Boolean	When `true`, sets the widget to a disabled state so the user cannot interact with it. more details	Swipe
String	The text that shows in a tooltip when hovering over the handle of the Swipe widget. more details	Swipe
String	Icon which represents the widget. more details	Swipe
String	The widget's default CSS icon class. more details	Swipe
String	The unique ID assigned to the widget when the widget is created. more details	Widget
String	The widget's default label. more details	Swipe
Collection<Layer>	A collection of Layers that will show on the left or top side of the Swipe widget. more details	Swipe
Number	The position of the Swipe widget. more details	Swipe
Collection<Layer>	A collection of Layers that will show on the right or bottom side of the Swipe widget. more details	Swipe
MapView	A reference to the MapView. more details	Swipe
SwipeViewModel	The view model for this widget. more details	Swipe
Boolean	Indicates whether the widget is visible. more details	Widget
VisibleElements	The visible elements that are displayed within the widget. more details	Swipe

Property Details

container String|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

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

Possible Values:"horizontal"|"vertical"

Default Value:"horizontal"

disabled Boolean

When true, sets the widget to a disabled state so the user cannot interact with it.

Default Value:false

dragLabel String

The text that shows in a tooltip when hovering over the handle of the Swipe widget.

icon String Since: ArcGIS Maps SDK for JavaScript 4.27

Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

Default Value:null

See also

Calcite Icon Search

iconClass String Deprecated since 4.27. Use icon instead.

The widget's default CSS icon class.

id String inherited

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

leadingLayers Collection<Layer>autocast

A collection of Layers that will show on the left or top side of the Swipe widget. See the image in the class description at the top of the page. Currently, all layers are supported except GroupLayers.

See also

trailingLayers

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

trailingLayers Collection<Layer>autocast

A collection of Layers that will show on the right or bottom side of the Swipe widget. See the image in the class description at the top of the page. Currently, all layers are supported except GroupLayers.

See also

leadingLayers

view MapView

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

viewModel SwipeViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the SwipeViewModel class to access all properties and methods on the widget.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default Value:true

Example

// Hides the widget in the view
widget.visible = false;

visibleElements VisibleElements

The visible elements that are displayed within the widget. This property provides the ability change the visibility of individual elements of the widget's display.

Properties

handle Boolean

Indicates whether the handle from which you drag the widget is visible. Default value is true.

divider Boolean

Indicates whether the divider between the leading and trailing layers is visible. Default value is true.

Example

swipe.visibleElements = {
  divider: true,
  handle: false // handle will not display
}

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object. more details	Accessor
String	A utility method used for building the value for a widget's `class` property. more details	Widget
	Destroys the widget instance. more details	Widget
Boolean	Emits an event on the instance. more details	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	Widget
Boolean	Returns true if a named group of handles exist. more details	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). more details	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected. more details	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved. more details	Widget
Object	Registers an event handler on the instance. more details	Widget
	Adds one or more handles which are to be tied to the lifecycle of the widget. more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	Widget
	Removes a group of handles owned by the object. more details	Accessor
Object	This method is primarily used by developers when implementing custom widgets. more details	Widget
	Renders widget to the DOM immediately. more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	Widget
Promise	`when()` may be leveraged once an instance of the class is created. more details	Widget

Method Details

addHandles(handleOrHandles, groupKey)inherited Since: ArcGIS Maps SDK 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 }
);

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.

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter

classNames String|String []|Object

repeatable

The class names.

Returns

Type	Description
String	The computed class name.

See also

Guide - Custom widget basics (rendering)

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [css.myIcon]: this.showIcon,
    [css.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

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

isFulfilled(){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handleOrHandles)inherited Since: ArcGIS Maps SDK for JavaScript 4.24 Deprecated since 4.28 Use addHandles() instead.

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

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

this.own(handle); // Handle gets removed when the widget is destroyed.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

removeHandles(groupKey)inherited Since: ArcGIS Maps SDK 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");

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

when(callback, errback){Promise}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new promise for the result of `callback`.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties

handle Boolean

Indicates whether the handle from which you drag the widget is visible. Default value is true.

divider Boolean

Indicates whether the divider between the leading and trailing layers is visible. Default value is true.

ArcGIS Maps SDK for JavaScriptAPI Reference

Was this page helpful?