import "@arcgis/map-components/components/arcgis-navigation-toggle";The Navigation Toggle component can be used to control the navigation mode of a Scene component.
When the navigation mode is set to "pan" (default), the mouse drag gesture pans the view and right-click + drag allows the user to rotate the view. When the navigation mode is set to "rotate", the mouse drag gesture rotates the view and right-click + drag pans the view.
Known limitations
Navigation Toggle is only supported in a 3D Scene component.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
icon | string | |
label | string | |
layout | "horizontal" | "vertical" | |
| Record<string, unknown> | |
navigation-mode | "pan" | "rotate" | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
statereadonly | state | "disabled" | "ready" |
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
layout
layout: "horizontal" | "vertical"The layout direction of the component.
- Attribute
- layout
- Default value
- "vertical"
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
navigationMode
navigationMode: "pan" | "rotate"The navigation mode of the view. The possible values:
pan- The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.rotate- The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.
- Attribute
- navigation-mode
- Default value
- "pan"
position
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
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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.
- Attribute
- reference-element
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state" | "layout"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state" | "layout"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
toggle(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisNavigationToggle = document.querySelector("arcgis-navigation-toggle");
document.body.append(arcgisNavigationToggle);
await arcgisNavigationToggle.componentOnReady();
console.log("arcgis-navigation-toggle is ready to go!");- Returns
- Promise<void>