Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-directional-pad";No specific import is needed for this component.
A directional pad (D-Pad) component can be used to control the position and rotation of the map. The D-Pad provides eight directions of movement, a small compass which indicates the current orientation of the map and a slider for rotating the map.
It is also possible to disable the map's rotation controls or change the size of the component.
The Directional Pad component is not supported in 3D.
Demo Properties autoDestroyDisabledProperty
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.
Property
disabled: boolean
Indicates whether interaction is allowed on the component. When true, this property sets the component to a disabled state to disable any user interaction.
Property
hideDirectionalButtons: boolean
Whether to hide directional pad buttons.
Property
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.
Property
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
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.
Property
showRotationResetButton: boolean
Whether to display the button to reset the rotation angle. This only takes effect if showRotationSlider is true.
Property
showRotationSlider: boolean
Whether to display the map rotation slider.
state: "disabled" | "moving" | "ready"
The current state of the component.
Property
visualScale: "l" | "m" | "s"
Determines the size of directional pad buttons and the slider.
In addition to this parameter, you can set the width on the component container to dictate directional pad size.
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
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 arcgisDirectionalPad = document.querySelector("arcgis-directional-pad");
document.body.append(arcgisDirectionalPad);
await arcgisDirectionalPad.componentOnReady();
console.log("arcgis-directional-pad is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
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