Swipe

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-swipe";

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

This component is not currently supported within an arcgis-scene component.

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`direction`	`direction`	`"horizontal" \| "vertical"`
`disabled`	`disabled`	`boolean`
`hideDivider`	`hide-divider`	`boolean`
`hideHandle`	`hide-handle`	`boolean`
`icon`	`icon`	`string`
`label`	`label`	`string`
`leadingLayers`		`Collection<Layer>`
`messageOverrides`		`{ componentLabel?: string \| undefined; dragLabel?: string \| undefined; }`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`state` readonly	`state`	`"disabled" \| "ready"`
`swipePosition`	`swipe-position`	`number`
`trailingLayers`		`Collection<Layer>`

autoDestroyDisabled

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 temporary 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

Property

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.

Attribute: direction
Default value: "horizontal"

disabled

Property

disabled: boolean

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

Attribute: disabled
Default value: false

hideDivider

Property

hideDivider: boolean

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

Attribute: hide-divider
Default value: false

hideHandle

Property

hideHandle: boolean

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

Attribute: hide-handle
Default value: false

icon

Property

icon: string

Icon which represents the component.

Attribute: icon
Default value: "compare"

label

Property

label: string

The component's default label.

Attribute: label
Default value: "Swipe"

leadingLayers

Property

leadingLayers: Collection<Layer>

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

messageOverrides

Property

messageOverrides: {
    componentLabel?: string | undefined;
    dragLabel?: string | undefined;
}

Replace localized message strings with your own strings.

position

Property

position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"

Attribute: position
Default value: "manual"

referenceElement

Property

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

state

readonly

Property

state: "disabled" | "ready"

The current state of the component.

Attribute: state
Default value: "disabled"

swipePosition

Property

swipePosition: number

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

trailingLayers

Property

trailingLayers: Collection<Layer>

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

Methods

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

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component

Returns: Promise<void>

Events

Event	Type
`arcgisPropertyChange`	`{ name: "state"; }`
`arcgisReady`	`undefined`

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "state"; }

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

arcgisReady

Event

arcgisReady: undefined