arcgis-swipe | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/map-components/components/arcgis-swipe";

Inheritance:: ArcgisSwipe→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 4.31

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 startLayers and endLayers 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

This component is not currently supported within a Scene component.

See also

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`direction` reflected	`direction`	`Direction`
`disabled` reflected	`disabled`	`boolean`
`endLayers`		`Collection<Layer>`
`hideDivider` reflected	`hide-divider`	`boolean`
`hideHandle` reflected	`hide-handle`	`boolean`
`icon`	`icon`	`string \| undefined`
`label`	`label`	`string \| undefined`
`leadingLayers` deprecated		`Collection<Layer>`
`messageOverrides`		`Record<string, unknown> \| undefined`
`position`	`position`	`number`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`startLayers`		`Collection<Layer>`
`state` readonly		`State`
`swipePosition` deprecated	`swipe-position`	`number`
`trailingLayers` deprecated		`Collection<Layer>`
`view`		`MapView \| null \| undefined`

autoDestroyDisabled

Property

Type: 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.

Attribute: auto-destroy-disabled
Default value: false

direction

reflected Property

Type: Direction

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"

disabled

reflected Property

Type: boolean

When true, the component is visually withdrawn and cannot receive user interaction.

Attribute: disabled
Default value: false

endLayers

Property

Type: Collection<Layer>

Since: ArcGIS Maps SDK for JavaScript 5.0

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

See also

trailingLayers

hideDivider

reflected Property

Type: boolean

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

Attribute: hide-divider
Default value: false

hideHandle

reflected Property

Type: boolean

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

Attribute: hide-handle
Default value: false

icon

Property

Type: string | undefined

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"

label

Property

Type: string | undefined

The component's default label.

Attribute: label
Default value: "Swipe"

leadingLayers

deprecated Property

Type: Collection<Layer>

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

See also

leadingLayers

messageOverrides

Property

Type: Record<string, unknown> | undefined

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

position

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

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

Attribute: position
Default value: 25

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

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

startLayers

Property

Type: Collection<Layer>

Since: ArcGIS Maps SDK for JavaScript 5.0

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

See also

leadingLayers

state

readonly Property

Type: State

The current state of the component.

Default value: "disabled"

swipePosition

deprecated Property

Type: number

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

Attribute: swipe-position
Default value: 25

trailingLayers

deprecated Property

Type: Collection<Layer>

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

See also

trailingLayers

view

Property

Type: MapView | null | undefined

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 arcgis-swipe component will be associated with a map or scene component rather than using the view property.

Methods

Method	Signature
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`destroy`	`destroy(): Promise<void>`

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

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

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
`arcgisPropertyChange`	CustomEvent<{ name: "state"; }>
`arcgisReady`	CustomEvent<void>
`arcgisSwipeChange`	CustomEvent<void>
`arcgisSwipeInput`	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state"; }>

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

arcgisReady

Event

arcgisReady: CustomEvent<void>

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

arcgisSwipeChange

Event

arcgisSwipeChange: CustomEvent<void>

Since: ArcGIS Maps SDK for JavaScript 4.34

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.

arcgisSwipeInput

Event

arcgisSwipeInput: CustomEvent<void>

Since: ArcGIS Maps SDK for JavaScript 4.34

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