CoordinateConversion

The CoordinateConversion widget provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the widget provides a way to convert user input coordinates into a Point.

Several common formats are included by default:

XY - Longitude, Latitude (WGS84)
MGRS - Military Grid Reference System
UTM - Universal Transverse Mercator
DD - Decimal Degrees
DDM - Degrees Decimal Minutes
DMS - Degrees Minutes Seconds
Basemap - X, Y in the coordinate system used by the current Basemap in the units used by the Basemap. Web Mercator is the standard for Esri-provided basemaps.

Additional formats can be created by a developer and made available through the widget.

For information about gaining full control of widget styles, see the Styling topic.

See also:

Example:

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

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

Constructors

new CoordinateConversion(properties)

Parameter:

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	more details	Widget
Collection<Conversion>	A Collection containing every Conversion that the widget is currently displaying. more details	more details	CoordinateConversion
Point	Describes the location of the coordinates currently displayed by the widget as a Point. more details	more details	CoordinateConversion
String	The name of the class. more details	more details	Accessor
Collection<Format>	A Collection containing every Format that the widget is capable of displaying. more details	more details	CoordinateConversion
GoToOverride	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. more details	more details	CoordinateConversion
String	The unique ID assigned to the widget when the widget is created. more details	more details	Widget
String	The widget's default label. more details	more details	CoordinateConversion
String	Describes the current mode of the widget. more details	more details	CoordinateConversion
Boolean	If this property is set to `true`, multiple conversions can be displayed. more details	more details	CoordinateConversion
String	Determines whether the widget should expand up or down. more details	more details	CoordinateConversion
Number	The number of milliseconds of delay before conversion requests will be sent to the GeometryService. more details	more details	CoordinateConversion
MapView\|SceneView	A reference to the MapView or SceneView. more details	more details	CoordinateConversion
CoordinateConversionViewModel	The view model for this widget. more details	more details	CoordinateConversion
VisibleElements	The visible elements that are displayed within the widget. more details	more details	CoordinateConversion

Property Details

container String|HTMLElement inherited

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

conversions Collection<Conversion>

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

currentLocation Point

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

declaredClass Stringreadonly inherited

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

formats Collection<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.

goToOverride GoToOverride Since: ArcGIS API for JavaScript 4.8

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

See also:

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

id String 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.

label String

The widget's default label.

mode String

Describes the current mode of the widget.

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.

Possible Values:"live"|"capture"

Default Value:live

multipleConversions Boolean

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

orientation String

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

requestDelay Number

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

view MapView|SceneView

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

viewModel CoordinateConversionViewModel

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.

visibleElements VisibleElementsautocast Since: ArcGIS API for JavaScript 4.19

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.

Example:

coordinateWidget.visibleElements = {
  settingsButton: false,
  captureButton: false
};

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
String	A utility method used for building the value for a widget's `class` property. more details	more details	Widget
	Destroys the widget instance. more details	more details	Widget
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). more details	more details	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected. more details	more details	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved. more details	more details	Widget
	Widget teardown helper. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Object	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Renders widget to the DOM immediately. more details	more details	Widget
Promise<Point>	Attempt to convert a string into a Point. more details	more details	CoordinateConversion
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Promise	`when()` may be leveraged once an instance of the class is created. more details	more details	Widget

Method Details

classes(classNames){String}inherited

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

Parameter:

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

isFulfilled(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

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(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

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(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

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.

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.

when(callback, errback){Promise}inherited Since: ArcGIS API for JavaScript 4.19

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:

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of `callback` that may be used to chain additional functions.

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

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties:

settingsButton Boolean

optional

Indicates whether the settings button will be displayed. Default is true.

editButton Boolean

optional

Indicates whether the input coordinate button will be displayed. Default is true.

expandButton Boolean

optional

Indicates whether the expand and retract buttons will be displayed. Default is true.

captureButton Boolean

optional

Indicates whether the capture mode button will be displayed. Default is true.

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?

Was this page helpful?