DistanceMeasurementAnalysis | References | ArcGIS Maps SDK for JavaScript

import DistanceMeasurementAnalysis from "@arcgis/core/analysis/DistanceMeasurementAnalysis.js";

Inheritance:: DistanceMeasurementAnalysis→Analysis→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

DistanceMeasurementAnalysis computes the length of a Polyline in a 2D MapView.

To display a distance measurement, create an instance of a DistanceMeasurementAnalysis, assign a Polyline to the geometry property, and add it to MapView.analyses

Use the DistanceMeasurementAnalysisView2D to retrieve analysis results.

// create analysis
const distanceMeasurement = new DistanceMeasurementAnalysis({
  geometry: new Polyline({ })
});

// add to map view
view.analyses.add(distanceMeasurement);

// retrieve measured results from analysis view once available
const analysisView = await view.whenAnalysisView(distanceMeasurement);
await reactiveUtils.whenOnce(() => analysisView.result);

const result = analysisView.result;

To draw a distance measurement interactively, use the DistanceMeasurementAnalysisView2D.place() method.

const abortController = new AbortController();

try {
  await analysisView.place({ signal: abortController.signal });
} catch (error) {
  if (error.name === "AbortError") {
    console.log("Placement operation was cancelled.");
  }
}

// cancel the placement operation at some later point
abortController.abort();

Known Limitation

This analysis is only supported in a 2D MapView.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DistanceMeasurementAnalysisProperties`

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

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`geometry`	`Polyline \| null \| undefined`
`id` readonly inherited	`string`	Analysis
`origin` inherited	`AnalysisOriginWebScene \| null \| undefined`	Analysis
`type` readonly	`"distance-measurement"`
`uid` readonly inherited	`string`	IdentifiableMixin
`unit`	`SystemOrLengthUnit \| null \| undefined`
`valid` readonly	`boolean`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

geometry

autocast Property

Type: Polyline | null | undefined

Polyline whose length is to be computed and displayed in the view.

If the polyline has z-values then these will be treated as absolute values.

id

readonlyinherited Property

Type: string

Inherited from: Analysis

A user settable identifier for the analysis. A unique value is automatically generated when the analysis is created if it is not set explicitly during construction.

origin

autocast inherited Property

Type: AnalysisOriginWebScene | null | undefined

Inherited from: Analysis

The origin of the analysis. The origin can be of type web-scene when the analysis was applied from the WebScene.initialViewProperties or a Slide.

type

readonly Property

Type: "distance-measurement"

The type of analysis. For distance measurement analysis, this is always "distance-measurement".

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

Since: ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

unit

Property

Type: SystemOrLengthUnit | null | undefined

Unit system (imperial, metric) or specific unit used for displaying the computed lengths in the view.

valid

readonly Property

Type: boolean

Indicates whether the analysis is ready to be computed and interacted with in the view. It requires the geometry to be a valid polyline whose first path contains at least 2 points.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clear`	`clear(): void`
`clone` inherited	`clone(): this`	ClonableMixin
`equals` inherited	`equals(other: this): boolean`	Analysis
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clear

Method

Signature: clear (): void

Clears the analysis by resetting the geometry property.

Returns: void

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

equals

inherited Method

Signature: equals (other: this): boolean

Inherited from: Analysis

Compares this analysis with another analysis to determine whether they are equivalent.

Parameters

Parameter	Type	Description	Required
other	`this`	The other analysis to compare against.

Returns: boolean
true if the analyses are equivalent and false otherwise.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.