ImageDistanceParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Input parameters used by the ImageryLayer.measureDistanceAndAngle() or imageService.measureDistanceAndAngle() methods to perform imagery distance and angle mensuration.

See also

Constructors

ImageDistanceParameters Constructor new ImageDistanceParameters(properties)

Parameter

properties Object

optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The angular unit used for angle calculation.	ImageDistanceParameters
String	The name of the class.	Accessor
Point	A point that defines the from location of the distance and angle measurement.	ImageDistanceParameters
Boolean	When `true`, this method calculates the 3D measurements for the distance and angle between two points on an image service.	ImageDistanceParameters
LengthUnit	The linear unit used for distance calculation.	ImageDistanceParameters
MosaicRule	Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed.	ImageDistanceParameters
Point	Specifies the pixel size.	ImageDistanceParameters
Point	A point that defines the to location of the distance and angle measurement.	ImageDistanceParameters
String	The string value representing the type of imagery mensuration.	ImageDistanceParameters

Property Details

angularUnit Property angularUnit String

The angular unit used for angle calculation.

Possible Values:"degrees" |"radians"

Default Value:"degrees"

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

fromGeometry Property fromGeometry Point

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

is3D Property 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 Property linearUnit LengthUnit

The linear unit used for distance calculation.

Default Value:"meters"

mosaicRule Property mosaicRule MosaicRuleautocast Since: ArcGIS Maps SDK for JavaScript 4.27 ImageDistanceParameters since 4.26, mosaicRule added at 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 Property pixelSize Pointautocast Since: ArcGIS Maps SDK for JavaScript 4.27 ImageDistanceParameters since 4.26, pixelSize added at 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 Property toGeometry Point

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

type Property type Stringreadonly

The string value representing the type of imagery mensuration.

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

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.	Accessor
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	ImageDistanceParameters
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	ImageDistanceParameters

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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 Method 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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 Inherited Method removeHandles(groupKey) Inherited from Accessor

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