RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html below:

DirectionalPad | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import DirectionalPad from "@arcgis/core/widgets/DirectionalPad.js";

CDN: const DirectionalPad = await $arcgis.import("@arcgis/core/widgets/DirectionalPad.js");

Class: @arcgis/core/widgets/DirectionalPad

Since: ArcGIS Maps SDK for JavaScript 4.29

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.

See also

DirectionalPadViewModel

Example

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

DirectionalPad Constructor new DirectionalPad(properties)

Parameter

optional

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 Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties Hide inherited properties

Property Details

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"
});

declaredClass Inherited Property declaredClass Stringreadonly: The name of the class. The declared class name is formatted as esri.folder.className.

: Indicates whether interaction is allowed on the widget. When true, this property sets the widget to a disabled state to disable any user interaction.

: Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

id Inherited Property id String: The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

: The widget's default label.

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.

: 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 Inherited Property visible Boolean

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".

Example

// Hides the widget in the view
widget.visible = false;

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 Property 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"

Example

// Make buttons and slider larger
directionalPad.visualScale = 'l';

Method Overview

Show inherited methods Hide inherited methods

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey)

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();

Parameters

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Inherited Method classes(classNames){String}

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Returns

Type 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)} />
  );
}

destroy Inherited Method destroy(): Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean}

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

The name of the event.

optional

The event payload.

Returns

Type Description Boolean true if a listener was notified

hasEventListener Inherited Method hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Returns

Type Description Boolean Returns true if the class supports the input event.

hasHandles Inherited Method hasHandles(groupKey){Boolean}

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type 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 Inherited Method isFulfilled(){Boolean}

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.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been resolved.

on Inherited Method on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Returns

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

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

postInitialize Inherited Method postInitialize(): Executes after widget is ready for rendering.

removeHandles Inherited Method removeHandles(groupKey)

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

render Inherited Method render(){Object}

This method is implemented by subclasses for rendering.

Returns

Type Description Object The rendered virtual node.

renderNow Inherited Method renderNow(): Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender(): Schedules widget rendering. This method is useful for changes affecting the UI.

when Inherited Method when(callback, errback){Promise}

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

optional

The function to call when the promise resolves.

optional

The function to execute when the promise fails.

Returns

Type 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

VisibleElements Type Definition VisibleElements

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

optional

Default Value:true

Indicates whether to display the directional pad buttons. This can be disabled if only the map rotation slider is needed

optional

Default Value:false

Indicates 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.

optional

Default Value:false

Indicates whether to display the button to reset the rotation angle. If rotation slider is hidden, rotation reset button will be hidden too.

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