Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-swipe";No specific import is needed for this component.
The Swipe component 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 component, set the leadingLayers and trailingLayers properties to determine what will be compared on either side of the component. If one of these properties is not set, then the Swipe component will overlay the existing map.
Known limitations
Property
autoDestroyDisabled: boolean
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.
direction: "horizontal" | "vertical"
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.
disabled: boolean
When true, sets the component to a disabled state so the user cannot interact with it.
hideDivider: boolean
When true, the divider between the leading and trailing layers will be hidden.
hideHandle: boolean
When true, the handle from which you drag the component will be hidden.
Property
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
Property
label: string
The component's default label.
Property
A collection of layers that will show on the left or top side of the Swipe component.
Property
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
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.
state: "disabled" | "ready"
The current state of the component.
Property
swipePosition: number
The position of the Swipe component. This determines what percentage of the view will be taken up by the leadingLayers.
Property
A collection of layers that will show on the right or bottom side of the Swipe component.
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods componentOnReadyMethod
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
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!");Method
destroy(): Promise<void>
Permanently destroy the component.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4