var ccWidget = new CoordinateConversion({
  view: view
});

// Adds widget in the bottom left corner of the view
view.ui.add(ccWidget, "bottom-left");

Property Overview

Property Details

containerString|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once.

conversionsCollection<Conversion>

A Collection containing every Conversion that the widget is currently displaying.

currentLocationPoint

Describes the location of the coordinates currently displayed by the widget as a Point. Setting this property will update all conversions.

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

destroyedBoolean inherited

When true, this property indicates whether the widget has been destroyed.

formatsCollection<Format>

A Collection containing every Format that the widget is capable of displaying.

The default formats are basemap, dd, ddm, dms, mgrs, usng, utm, and xy.

goToOverrideGoToOverride

Since: ArcGIS API for JavaScript 4.8

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also:

• MapView
• SceneView

Example:

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

idString inherited

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.

modeString

Describes the current mode of the widget.

Possible Values: live | capture

• While in live mode, the widget will update as the cursor moves.
• While in capture mode, the widget will update on mouse click and display a graphic marking the current location.

Default Value:live

multipleConversionsBoolean

If this property is set to true, multiple conversions can be displayed. For a simpler experience with only one conversion at a time, this property can be set to false.

Default Value:true

orientationString

Determines whether the widget should expand up or down. If set to auto the widget will be oriented based on its position in the view.

Possible Values: auto | expand-up | expand-down

Default Value:auto

requestDelayNumber

The number of milliseconds of delay before conversion requests will be sent to the GeometryService. This only affects conversions that cannot be performed in the browser.

Default Value:300

viewMapView|SceneView

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

viewModelCoordinateConversionViewModel

The view model for this widget. The view model contains the logic that controls the Coordinate Widget's behavior. See the CoordinateConversionViewModel class to access all properties and methods on the widget.

Method Overview

Method Details

classes(classNames){String}inherited

Since: ArcGIS API for JavaScript 4.7

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

Prior to version 4.7, there were various approaches towards setting CSS classes. These were dependent upon variables, such as whether the classes were:

• a single static class,
• multiple static classes, or
• dynamic classes.

This helper method takes all of these approaches into account and simplifies it to use one single pattern to accommodate these multiple approaches.

Parameter:

classNames Array<(String|String[]|Object)> repeatable The class names.

Returns:

Type	Description
String	The computed class name.

See also:

• Guide - Widget development (rendering)

Example:

// .tsx syntax showing how to set CSS classes while rendering the widget
render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

Destroys the widget instance.

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles WatchHandle|WatchHandle[] Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

reverseConvert(coordinate, format){Promise<Point>}

Attempt to convert a string into a Point. The format of the string must be specified. A Collection of available formats can be obtained from the formats property.

Parameters:

coordinate String The coordinate string.

format Format Specifies the format of the input coordinate.

Returns:

Type	Description
Promise<Point>	When resolved, returns a Point.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.