CoordinateConversion | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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.

See also

Example

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

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

Constructors

CoordinateConversion Constructor 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
let ccWidget = new CoordinateConversion({
  view: view
});

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget.	Widget
Collection<Conversion>	A Collection containing every Conversion that the widget is currently displaying.	CoordinateConversion
Point	Describes the location of the coordinates currently displayed by the widget as a Point.	CoordinateConversion
String	The name of the class.	Accessor
Collection<Format>	A Collection containing every Format that the widget is capable of displaying.	CoordinateConversion
GoToOverride	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.	CoordinateConversion
Number	Indicates the heading level to use for the coordinate input and coordinate settings headings.	CoordinateConversion
String	Icon which represents the widget.	CoordinateConversion
String	The unique ID assigned to the widget when the widget is created.	Widget
String	The widget's default label.	CoordinateConversion
SimpleMarkerSymbol\|PictureMarkerSymbol	This symbol is used to visualize the location currently described by the widget when `capture` mode is active.	CoordinateConversion
String	Describes the current mode of the widget.	CoordinateConversion
Boolean	If this property is set to `true`, multiple conversions can be displayed.	CoordinateConversion
String	Determines whether the widget should expand up or down.	CoordinateConversion
Boolean	If this property is set to `true`, sessionStorage or localStorage (depending on storageType) will be used to hydrate and persist the CoordinateConversion widget's state.	CoordinateConversion
String	This property determines whether sessionStorage or localStorage will be used to store widget state.	CoordinateConversion
MapView\|SceneView	A reference to the MapView or SceneView.	CoordinateConversion
CoordinateConversionViewModel	The view model for this widget.	CoordinateConversion
Boolean	Indicates whether the widget is visible.	Widget
VisibleElements	The visible elements that are displayed within the widget.	CoordinateConversion

Property Details

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

conversions Property conversions Collection<Conversion>

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

Example

// conversions can be set with an array of strings where each string is a format's name
coordinateConversion.conversions = ["mgrs"];

currentLocation Property currentLocation Pointreadonly

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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

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

Examples

// only show "xy" format
let ccWidget = new CoordinateConversion({
  view: view
});
const toRemove = ccWidget.formats.filter(format => format.name !== "xy");
ccWidget.formats.removeMany(toRemove);
view.ui.add(ccWidget, "bottom-left");

// show every format except "xy"
let ccWidget = new CoordinateConversion({
  view: view
});
const toRemove = ccWidget.formats.filter(format => format.name == "xy");
ccWidget.formats.removeMany(toRemove);
view.ui.add(ccWidget, "bottom-left");

goToOverride Property goToOverride GoToOverride Since: ArcGIS Maps SDK for JavaScript 4.8 CoordinateConversion since 4.7, goToOverride added at 4.8.

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

See also

esri/views/MapView#goTo
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);
};

headingLevel Property headingLevel Number Since: ArcGIS Maps SDK for JavaScript 4.20 CoordinateConversion since 4.7, headingLevel added at 4.20.

Indicates the heading level to use for the coordinate input and coordinate settings headings. By default, these headings are rendered as level 4 headings (e.g. <h4>Input coordinate</h4>). Depending on the coordinate conversion widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:4

Example

// coordinate conversion heading will render as an <h2>
coordinateConversion.headingLevel = 2;

icon Property icon String Since: ArcGIS Maps SDK for JavaScript 4.27 CoordinateConversion since 4.7, icon added at 4.27.

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:"coordinate-system"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

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 Property label String

The widget's default label.

locationSymbol Property locationSymbol SimpleMarkerSymbol |PictureMarkerSymbol

This symbol is used to visualize the location currently described by the widget when capture mode is active.

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

storageEnabled Property storageEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.20 CoordinateConversion since 4.7, storageEnabled added at 4.20.

If this property is set to true, sessionStorage or localStorage (depending on storageType) will be used to hydrate and persist the CoordinateConversion widget's state.

Default Value:true

storageType Property storageType String Since: ArcGIS Maps SDK for JavaScript 4.23 CoordinateConversion since 4.7, storageType added at 4.23.

This property determines whether sessionStorage or localStorage will be used to store widget state.

Possible Values:"session" |"local"

Default Value:"session"

See also

view Property view MapView |SceneView

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

viewModel Property 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.

visible Inherited Property visible 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 Property visibleElements VisibleElements Since: ArcGIS Maps SDK for JavaScript 4.19 CoordinateConversion since 4.7, visibleElements added at 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
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
String	A utility method used for building the value for a widget's `class` property.	Widget
	Destroys the widget instance.	Widget
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	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
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
Promise<Point>	Attempt to convert a string into a Point.	CoordinateConversion
	Schedules widget rendering.	Widget
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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

handleOrHandles WatchHandle|WatchHandle []

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} Inherited from Widget

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.

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() Inherited from Widget

Destroys the widget instance.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 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 Inherited Method isRejected(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 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 Inherited Method isResolved(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 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 Inherited Method own(handleOrHandles) Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24. Deprecated 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.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

reverseConvert Method 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 Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

when Inherited Method when(callback, errback){Promise} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 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`.

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.

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.