Provides the logic for the CoordinateConversion widget.
Constructors
-
new CoordinateConversionViewModel(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
Collection<Conversion> | more details A Collection containing every Conversion that the widget is currently displaying. | more details | CoordinateConversionViewModel | |
Point | more details Describes the location of the coordinates currently displayed by the widget as a Point. | more details | CoordinateConversionViewModel | |
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 | CoordinateConversionViewModel | |
GoToOverride | more details This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. | more details | CoordinateConversionViewModel | |
SimpleMarkerSymbol|PictureMarkerSymbol | more details This symbol is used to visualize the location currently described by the widget when | more details | CoordinateConversionViewModel | |
String | more details Describes the current mode of the widget. | more details | CoordinateConversionViewModel | |
String | more details The view model's state. | more details | CoordinateConversionViewModel | |
Boolean | more details If this property is set to | more details | CoordinateConversionViewModel | |
String | more details This property determines whether sessionStorage or localStorage will be used to store widget state. | more details | CoordinateConversionViewModel | |
MapView|SceneView | more details | more details | CoordinateConversionViewModel |
Property Details
-
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); };
-
-
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
-
state Stringreadonly
-
The view model's state.
Possible Values:"ready"|"loading"|"disabled"
- Default Value:disabled
-
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:
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Promise<Position> | more details Attempt to convert a point into a Position. | more details | CoordinateConversionViewModel | |
Promise<Point> | more details Attempt to convert a string into a Point. | more details | CoordinateConversionViewModel | |
Promise<Conversion[]> | more details Update the input conversions based on the input point. | more details | CoordinateConversionViewModel |
Method Details
-
Attempt to convert a point into a Position.
Parameters:point PointThe point to convert.
format FormatThe format that describes how the point should be converted.
Returns:Type Description Promise<Position> When resolved, returns a Position.
-
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.
-
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 PointA 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.