require(["esri/widgets/DirectionalPad"], (DirectionalPad) => { /* code goes here */ });
import DirectionalPad from "@arcgis/core/widgets/DirectionalPad.js";
esri/widgets/DirectionalPad
A directional pad (D-Pad) widget 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 widget.
- The DirectionalPad widget is not supported in 3d.
const directionalPad = new DirectionalPad({
view: view
});
// adds the d-pad to the bottom left corner of the MapView
view.ui.add(directionalPad, "bottom-left");
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// Typical usage const directionalPad = new DirectionalPad({ view: view }); // adds the d-pad to the bottom left corner of the MapView view.ui.add(directionalPad, "bottom-left");
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The ID or node representing the DOM element containing the widget. | Widget | ||
The name of the class. | Accessor | ||
Indicates whether interaction is allowed on the widget. | DirectionalPad | ||
Icon which represents the widget. | DirectionalPad | ||
The unique ID assigned to the widget when the widget is created. | Widget | ||
The widget's default label. | DirectionalPad | ||
The view which the directional pad will control. | DirectionalPad | ||
The view model for the DirectionalPad widget. | DirectionalPad | ||
Indicates whether the widget is visible. | Widget | ||
The visible elements that are displayed within the widget. | DirectionalPad | ||
Determines the size of directional pad buttons and the slider. | DirectionalPad |
Property Details
-
container
InheritedPropertycontainer String |HTMLElement
Inherited from Widget -
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
disabled
disabled Boolean
-
Indicates whether interaction is allowed on the widget. When
true
, this property sets the widget to a disabled state to disable any user interaction.- Default Value:false
-
icon
icon String
-
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
- Default Value:"move"
- See also
-
label
label String
-
The widget's default label.
-
view
view MapView
-
The view which the directional pad will control. If not provided, you can manually listen to emitted events and control the map accordingly.
The DirectionalPad widget is not supported in 3d.
-
viewModel
viewModel DirectionalPadViewModel
-
The view model for the DirectionalPad widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the DirectionalPadViewModel class to access all properties and methods on the DirectionalPad widget.
-
visible
InheritedPropertyvisible Boolean
Inherited from Widget -
Indicates whether the widget is visible.
If
false
, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of"none"
.- Default Value:true
Example// Hides the widget in the view widget.visible = false;
-
visibleElements
visibleElements VisibleElementsautocast
-
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.
Examples// display all elements, except the rotation reset button directionalPad.visibleElements.rotationResetButton = false;
// disable all elements directionalPad.visibleElements = { directionalButtons: false, rotationSlider: false, rotationResetButton: false, };
-
visualScale
visualScale String
-
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.
Possible Values:"s" |"m" |"l"
- Default Value:'s'
Example// Make buttons and slider larger directionalPad.visualScale = 'l';
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A utility method used for building the value for a widget's | Widget | ||
Destroys the widget instance. | Widget | ||
Emits an event on the instance. | Widget | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Widget | ||
Returns true if a named group of handles exist. | Accessor | ||
| Widget | ||
| Widget | ||
| Widget | ||
Registers an event handler on the instance. | Widget | ||
Adds one or more handles which are to be tied to the lifecycle of the widget. | Widget | ||
Executes after widget is ready for rendering. | Widget | ||
Removes a group of handles owned by the object. | Accessor | ||
This method is implemented by subclasses for rendering. | Widget | ||
Renders widget to the DOM immediately. | Widget | ||
Schedules widget rendering. | Widget | ||
| Widget |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
classes
InheritedMethodclasses(classNames){String}
Inherited from Widget -
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set css classes while rendering the widget render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary }; return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> ); }
-
Inherited from Widget
-
Destroys the widget instance.
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Widget -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from Widget -
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from Widget -
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from Widget -
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
on
InheritedMethodon(type, listener){Object}
Inherited from Widget -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from WidgetDeprecated since 4.28 Use addHandles() instead.
-
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
Inherited from Widget
-
Executes after widget is ready for rendering.
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Widget
-
Renders widget to the DOM immediately.
-
Inherited from Widget
-
Schedules widget rendering. This method is useful for changes affecting the UI.
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from Widget -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new Promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Type Definitions
-
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off. Alternatively, developers may also use CSS (e.g.
display: none
) to show/hide elements, such as labels.- Properties
-
directionalButtons BooleanDefault Value:true
Indicates whether to display the directional pad buttons. This can be disabled if only the map rotation slider is needed
rotationSlider BooleanDefault Value:falseIndicates whether to display the map rotation slider. This can be disabled if only the directional buttons are needed. Note, this is independent of the
view.constraints.rotationEnabled
setting.rotationResetButton BooleanDefault Value:falseIndicates whether to display the button to reset the rotation angle. If rotation slider is hidden, rotation reset button will be hidden too.