Zoom

1
import "@arcgis/map-components/components/arcgis-zoom";

Zoom component allows users to zoom in/out within a view.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
icon
string
label
string
layout
"horizontal" | "vertical"
{ componentLabel?: string | undefined; zoomIn?: string | undefined; zoomOut?: string | undefined; }
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
state
readonly
state
"disabled" | "ready"

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

icon

Property
icon: string

Icon which represents the component.

Attribute
icon
Default value
"magnifying-glass-plus"

label

Property
label: string

The component's default label.

Attribute
label

layout

Property
layout: "horizontal" | "vertical"

Determines the layout/orientation of the Zoom widget.

Attribute
layout
Default value
"vertical"

messageOverrides

Property
messageOverrides: { componentLabel?: string | undefined; zoomIn?: string | undefined; zoomOut?: 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
"top-left"

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"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>
zoomIn(): Promise<void>
zoomOut(): 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>

zoomIn

Method
zoomIn(): Promise<void>

Zooms the view in by an LOD factor of 0.5.

Returns
Promise<void>

zoomOut

Method
zoomOut(): Promise<void>

Zooms the view out by an LOD factor of 2.

Returns
Promise<void>

Events

EventType
{ name: "state"; }
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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close