import CoordinateConversion from "@arcgis/core/widgets/CoordinateConversion.js";const CoordinateConversion = await $arcgis.import("@arcgis/core/widgets/CoordinateConversion.js");- Since
- ArcGIS Maps SDK 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.
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.
Example
let ccWidget = new CoordinateConversion({ view: view});
// Adds widget in the bottom left corner of the viewview.ui.add(ccWidget, "bottom-left");Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Example
// typical usagelet ccWidget = new CoordinateConversion({ view: view});Properties
| Property | Type | Class |
|---|---|---|
container inherited | HTMLElement | null | undefined | |
| | ||
| | ||
declaredClass readonly inherited | ||
destroyed readonly inherited | ||
| | ||
| | ||
| | ||
Icon["icon"] | | |
id inherited | ||
| | ||
CoordinateConversionViewModel["locationSymbol"] | | |
| | ||
| | ||
| | ||
| | ||
CoordinateConversionViewModel["storageType"] | | |
| | ||
| | ||
visible inherited | ||
| |
container
- Type
- HTMLElement | null | undefined
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 containerconst basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div")});
// Add the widget to the top-right corner of the viewview.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 viewview.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 UIconst basemapGallery = new BasemapGallery({ view: view});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"}); conversions
- Type
- 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 namecoordinateConversion.conversions = ["mgrs"]; currentLocation
Describes the location of the coordinates currently displayed by the widget as a Point. Setting this property will update all conversions.
formats
- Type
- 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" formatlet 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
- Type
- GoToOverride | null | undefined
- Since
- ArcGIS Maps SDK 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 Search 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
- Type
- HeadingLevel
- Since
- ArcGIS Maps SDK 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; icon
- Type
- Icon["icon"]
- Since
- ArcGIS Maps SDK for JavaScript 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"
locationSymbol
- Type
- CoordinateConversionViewModel["locationSymbol"]
This symbol is used to visualize the location currently described by the widget when capture mode
is active.
mode
- Type
- Mode
Describes the current mode of the widget.
- While in
livemode, the widget will update as the cursor moves. - While in
capturemode, the widget will update on mouse click and display a graphic marking the current location.
- Default value
- "live"
multipleConversions
- Type
- 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
storageEnabled
- Type
- boolean
- Since
- ArcGIS Maps SDK 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
- Type
- CoordinateConversionViewModel["storageType"]
- Since
- ArcGIS Maps SDK for JavaScript 4.23
This property determines whether sessionStorage or localStorage will be used to store widget state.
- Default value
- "session"
view
- Type
- MapViewOrSceneView | null | undefined
viewModel
- Type
- CoordinateViewModel
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
- Type
- boolean
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 DefaultUI, 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 viewwidget.visible = false; visibleElements
- Type
- VisibleElements
- Since
- ArcGIS Maps SDK 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};Methods
| Method | Signature | Class |
|---|---|---|
classes inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
destroy inherited | destroy(): void | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
postInitialize inherited | postInitialize(): void | |
render inherited | render(): any | null | |
renderNow inherited | renderNow(): void | |
reverseConvert(coordinate: string, format: Format): Promise<Point | null | undefined> | | |
scheduleRender inherited | scheduleRender(): void | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- 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)} /> );} emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
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
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); reverseConvert
- Signature
-
reverseConvert (coordinate: string, format: Format): Promise<Point | null | undefined>
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.
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.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});