Conversion

See also

Constructors

new Conversion(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example

const ccWidget = new CoordinateConversion({
   view: view
});

const newFormat = new Format({
   // add new conversion format here
});

// add our new format to the widget's dropdown
ccWidget.formats.add(newFormat);

const newConversion = new Conversion({
   format: newFormat
});

// add the custom format to the top of the widget's display
ccWidget.conversions.splice(0, newConversion);

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class. more details	Accessor
String	A formatted string based on the current position and display information on the format. more details	Conversion
Format	The Format for this conversion. more details	Conversion
Position	The position property contains the location information for this conversion. more details	Conversion

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

displayCoordinate Stringreadonly

A formatted string based on the current position and display information on the format.

format Format

The Format for this conversion. The Format contains information detailing how the Conversion should be performed and how it will be displayed.

position Position

The position property contains the location information for this conversion.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object. more details	Accessor
Boolean	Returns true if a named group of handles exist. more details	Accessor
	Removes a group of handles owned by the object. more details	Accessor

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.

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

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.

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?