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.
The Navigation Toggle component is only supported in 3D.
Demo
Properties
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
icon | string | |
label | string | |
layout | "horizontal" | "vertical" | |
navigation-mode | "pan" | "rotate" | |
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 | "disabled" | "ready" |
autoDestroyDisabled
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 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
icon
icon: string
Icon which represents the component. It is typically used when the component is controlled by another one (e.g. in the arcgis-expand component).
- Attribute
- icon
layout
layout: "horizontal" | "vertical"
The layout direction of the component.
- Attribute
- layout
- Default value
- "vertical"
navigationMode
navigationMode: "pan" | "rotate"
The navigation mode of the view. See the table below for a list of possible values.
Possible Value | Description ---------------|------------- 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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
toggle(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state" | "layout"; } | |
undefined |