ImageDistanceParameters

Property Overview

Property Details

angularUnit String

The angular unit used for angle calculation.

Possible Values:"degrees"|"radians"

Default Value:"degrees"

declaredClass Stringreadonly inherited

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

fromGeometry Point

A point that defines the from location of the distance and angle measurement.

is3D Boolean

When true, this method calculates the 3D measurements for the distance and angle between two points on an image service. The elevation surface will be incorporated when performing the calculations. 3D calculation can only be done when the layer's capabilities.mensuration.supports3D returns true.

Default Value:false

linearUnit String

The linear unit used for distance calculation.

Possible Values:"millimeters"|"centimeters"|"decimeters"|"meters"|"kilometers"|"inches"|"feet"|"yards"|"miles"|"nautical-miles"|"us-feet"

Default Value:"meters"

mosaicRule MosaicRuleautocast

Since: ArcGIS Maps SDK for JavaScript 4.27

Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed. When a mosaic rule is not specified, the current settings on the ImageryLayer will be used.

pixelSize PixelSizeautocast

Since: ArcGIS Maps SDK for JavaScript 4.27

Specifies the pixel size. If pixel size is not specified, pixelSize will default to the base resolution of the image service. The raster at the specified pixel size in the mosaic dataset will be used for the Measure calculation.

toGeometry Point

A point that defines the to location of the distance and angle measurement.

type Stringreadonly

The string value representing the type of imagery mensuration.

For ImageDistanceParameters the type is always "distance-angle".

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

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

this.addHandles(handle);

// Destroy the object
this.destroy();

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.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns

Type	Description
*	Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

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

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

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.