Skip To ContentArcGIS for DevelopersSign In Dashboard

CoordinateConversion

require(["esri/widgets/CoordinateConversion"], function(CoordinateConversion) { /* code goes here */ });
Class: esri/widgets/CoordinateConversion
Inheritance: CoordinateConversion Widget Accessor
Since: ArcGIS API for JavaScript 4.7

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.

coordinate-conversion

Several common formats are included by default:

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.
NameTypeSummaryClass
String|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
Collection<Conversion>

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

more details
more detailsCoordinateConversion
Point

Describes the location of the coordinates currently displayed by the widget as a Point.

more details
more detailsCoordinateConversion
String

The name of the class.

more details
more detailsAccessor
Boolean

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

more details
more detailsWidget
Collection<Format>

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

more details
more detailsCoordinateConversion
GoToOverride

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

more details
more detailsCoordinateConversion
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's label.

more details
more detailsWidget
String

Describes the current mode of the widget.

more details
more detailsCoordinateConversion
Boolean

If this property is set to true, multiple conversions can be displayed.

more details
more detailsCoordinateConversion
String

Determines whether the widget should expand up or down.

more details
more detailsCoordinateConversion
Number

The number of milliseconds of delay before conversion requests will be sent to the GeometryService.

more details
more detailsCoordinateConversion
MapView|SceneView

A reference to the MapView or SceneView.

more details
more detailsCoordinateConversion
CoordinateConversionViewModel

The view model for this widget.

more details
more detailsCoordinateConversion

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

destroyed Boolean inherited

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

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

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.

Since: ArcGIS API for JavaScript 4.11

The widget's label.

This property is useful whenever the widget is controlled by another one (e.g. Expand)

mode String

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

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

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

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget
Promise<Point>

Attempt to convert a string into a Point.

more details
more detailsCoordinateConversion

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

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 Array<(string|Array<string>|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
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 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:
TypeDescription
ObjectThe 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:
TypeDescription
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.

API Reference search results

NameTypeModule
Loading...