Swipe

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.

Attribute

auto-destroy-disabled

Default value

false

The direction the Swipe component moves across the view. If "horizontal", the component will move left and right and if "vertical", the component will move up and down.

Attribute

direction

Default value

"horizontal"

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

Attribute

disabled

Default value

false

When true, the divider between the leading and trailing layers will be hidden.

Attribute

hide-divider

Default value

false

When true, the handle from which you drag the component will be hidden.

Attribute

hide-handle

Default value

false

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"compare"

The component's default label.

Attribute

label

Default value

"Swipe"

A collection of layers that will show on the left or top side of the Swipe component.

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

Attribute

position

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

Attribute

reference-element

The current state of the component.

Attribute

state

Default value

"disabled"

The position of the Swipe component. This determines what percentage of the view will be taken up by the leadingLayers.

Attribute

swipe-position

Default value

25

A collection of layers that will show on the right or bottom side of the Swipe component.

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Swipe component will be associated with a map or scene component rather than using the view property.

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
const arcgisSwipe = document.querySelector("arcgis-swipe");
document.body.append(arcgisSwipe);
await arcgisSwipe.componentOnReady();
console.log("arcgis-swipe is ready to go!");

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is ready to be interacted with.

Fires when the swipe position changes and the drag handle is released on the component.

Note: To constantly listen to changes while dragging, use the arcgisSwipeInput event instead.

Fires when the swipe position is updated. This event is fired continuously while dragging the handle.