CoordinateConversionViewModel

Property Overview

Property Details

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

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

locationSymbol SimpleMarkerSymbol|PictureMarkerSymbol

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

state Stringreadonly

The view model's state.

Possible Values:"ready"|"loading"|"disabled"

Default Value:disabled

storageEnabled Boolean

Since: 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 String

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

• Window.sessionStorage

• Window.localStorage

view MapView|SceneView

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

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

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.

convert(point, format){Promise<Position>}

Attempt to convert a point into a Position.

Parameters

point Point The point to convert.

format Format The format that describes how the point should be converted.

Returns

Type	Description
Promise<Position>	When resolved, returns a Position.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS API for JavaScript 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");
}

removeHandles(groupKey)inherited

Since: ArcGIS API for JavaScript 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");

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.

updateConversions(conversions, location){Promise<Conversion[]>}

Update the input conversions based on the input point.

Parameters

conversions Conversion[] An array of Conversions to be updated.

location Point A point that will be used to update each input conversion.

Returns

Type	Description
Promise<Conversion[]>	When resolved, returns an array of Conversions with updated Positions.

Type Definitions

Position

Describes a point in terms of a location, a Point, and a coordinate, a string.

Properties

location Point A point geometry representing the location described by the conversion.

coordinate String A string representing the location.