arcgis-directional-pad | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/map-components/components/arcgis-directional-pad";

Inheritance:: ArcgisDirectionalPad→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 4.29

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
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`disabled`	`disabled`	`boolean`
`hideDirectionalButtons`	`hide-directional-buttons`	`boolean`
`icon`	`icon`	`string \| undefined`
`label`	`label`	`string \| undefined`
`messageOverrides`		`Record<string, unknown> \| undefined`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`showRotationResetButton`	`show-rotation-reset-button`	`boolean`
`showRotationSlider`	`show-rotation-slider`	`boolean`
`state` readonly		`DirectionalPadViewModelState`
`view`		`MapView \| null \| undefined`
`visualScale`	`visual-scale`	`Button["scale"]`

autoDestroyDisabled

Property

Type: 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

disabled

Property

Type: boolean

When true, the component is visually withdrawn and cannot receive user interaction.

Attribute: disabled
Default value: false

hideDirectionalButtons

Property

Type: boolean

Whether to hide directional pad buttons.

Attribute: hide-directional-buttons
Default value: false

icon

Property

Type: string | undefined

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

Calcite Icons

Attribute: icon
Default value: "move"

label

Property

Type: string | undefined

The component's default label.

Attribute: label

messageOverrides

Property

Type: Record<string, unknown> | undefined

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

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.

See also

Associate components with a Map or Scene component

Attribute: reference-element

showRotationResetButton

Property

Type: boolean

Whether 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

Property

Type: boolean

Whether to display the map rotation slider.

Attribute: show-rotation-slider
Default value: false

state

readonly Property

Type: DirectionalPadViewModelState

The current state of the component.

view

Property

Type: MapView | null | undefined

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-directional-pad component will be associated with a map or scene component rather than using the view property.

visualScale

Property

Type: Button["scale"]

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"

Methods

Method	Signature
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`destroy`	`destroy(): Promise<void>`

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisDirectionalPad = document.querySelector("arcgis-directional-pad");
document.body.append(arcgisDirectionalPad);
await arcgisDirectionalPad.componentOnReady();
console.log("arcgis-directional-pad is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
`arcgisPropertyChange`	CustomEvent<{ name: "state"; }>
`arcgisReady`	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state"; }>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is ready to be interacted with.