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:
let 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 Objectoptional
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
Name | Type | Summary | Class | |
---|---|---|---|---|
String|HTMLElement | more details The ID or node representing the DOM element containing the widget. | more details | Widget | |
Collection<Conversion> | more details A Collection containing every Conversion that the widget is currently displaying. | more details | CoordinateConversion | |
Point | more details Describes the location of the coordinates currently displayed by the widget as a Point. | more details | CoordinateConversion | |
String | more details The name of the class. | more details | Accessor | |
Collection<Format> | more details A Collection containing every Format that the widget is capable of displaying. | more details | CoordinateConversion | |
GoToOverride | more details This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. | more details | CoordinateConversion | |
Number | more details Indicates the heading level to use for the coordinate input and coordinate settings headings. | more details | CoordinateConversion | |
String | more details The unique ID assigned to the widget when the widget is created. | more details | Widget | |
String | more details The widget's default label. | more details | CoordinateConversion | |
SimpleMarkerSymbol|PictureMarkerSymbol | more details This symbol is used to visualize the location currently described by the widget when | more details | CoordinateConversion | |
String | more details Describes the current mode of the widget. | more details | CoordinateConversion | |
Boolean | more details If this property is set to | more details | CoordinateConversion | |
String | more details Determines whether the widget should expand up or down. | more details | CoordinateConversion | |
Boolean | more details If this property is set to | more details | CoordinateConversion | |
String | more details This property determines whether sessionStorage or localStorage will be used to store widget state. | more details | CoordinateConversion | |
MapView|SceneView | more details | more details | CoordinateConversion | |
CoordinateConversionViewModel | more details The view model for this widget. | more details | CoordinateConversion | |
Boolean | more details Indicates whether the widget is visible. | more details | Widget | |
VisibleElements | more details The visible elements that are displayed within the widget. | more details | CoordinateConversion |
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.
-
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
, andxy
.
-
goToOverride GoToOverrideSince: ArcGIS API for JavaScript 4.8
-
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
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 NumberSince: ArcGIS API for JavaScript 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;
-
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.
-
-
This symbol is used to visualize the location currently described by the widget when
capture
mode is active.
-
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
- While in
-
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 tofalse
.- 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
-
storageEnabled BooleanSince: ArcGIS API for JavaScript 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 StringSince: ArcGIS API for JavaScript 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:
-
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.
-
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 VisibleElementsautocastSince: 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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
String | more details A utility method used for building the value for a widget's | more details | Widget | |
more details Destroys the widget instance. | more details | Widget | ||
Boolean | more details
| more details | Widget | |
Boolean | more details
| more details | Widget | |
Boolean | more details
| more details | Widget | |
more details Widget teardown helper. | more details | Widget | ||
more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | ||
Object | more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | |
more details Renders widget to the DOM immediately. | more details | Widget | ||
Promise<Point> | more details Attempt to convert a string into a Point. | more details | CoordinateConversion | |
more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | ||
Promise | more details
| more details | Widget |
Method Details
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying CSS class setup.Parameter:repeatable The class names.
Returns:Type Description String The 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.
-
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).
-
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.
-
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.
-
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.
-
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 StringThe coordinate string.
format FormatSpecifies 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.
-
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: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe 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
Indicates whether the settings button will be displayed. Default is
true
.editButton BooleanIndicates whether the input coordinate button will be displayed. Default is
true
.expandButton BooleanIndicates whether the expand and retract buttons will be displayed. Default is
true
.captureButton BooleanIndicates whether the capture mode button will be displayed. Default is
true
.