Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-navigation-toggle";
No specific import is needed for this component.
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 iconProperty
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.
layout: "horizontal" | "vertical"
The layout direction of the component.
Property
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
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.Property
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.
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state" | "layout"; }>
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 arcgisNavigationToggle = document.querySelector("arcgis-navigation-toggle");
document.body.append(arcgisNavigationToggle);
await arcgisNavigationToggle.componentOnReady();
console.log("arcgis-navigation-toggle is ready to go!");
Method
toggle(): Promise<void>
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