import "@arcgis/map-components/components/arcgis-directional-pad";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
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
disabled | boolean | |
hide-directional-buttons | boolean | |
icon | string | |
label | string | |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
show-rotation-reset-button | boolean | |
show-rotation-slider | boolean | |
statereadonly | state | "disabled" | "moving" | "ready" |
visual-scale | "l" | "m" | "s" |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
disabled
disabled: booleanIndicates whether interaction is allowed on the component. When true,
this property sets the component to a disabled state to disable any user
interaction.
- Attribute
- disabled
- Default value
- false
hideDirectionalButtons
hideDirectionalButtons: booleanWhether to hide directional pad buttons.
- Attribute
- hide-directional-buttons
- Default value
- false
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
- Default value
- "move"
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "bottom-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
showRotationResetButton
showRotationResetButton: booleanWhether to display the button to reset the rotation angle. This only takes effect if showRotationSlider is true.
- Attribute
- show-rotation-reset-button
- Default value
- false
showRotationSlider
showRotationSlider: booleanWhether to display the map rotation slider.
- Attribute
- show-rotation-slider
- Default value
- false
visualScale
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.
- Attribute
- visual-scale
- Default value
- "s"
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>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> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisDirectionalPad = document.querySelector("arcgis-directional-pad");
document.body.append(arcgisDirectionalPad);
await arcgisDirectionalPad.componentOnReady();
console.log("arcgis-directional-pad is ready to go!");- Returns
- Promise<void>