import DistanceMeasurementAnalysisView2D from "@arcgis/core/views/2d/analysis/DistanceMeasurementAnalysisView2D.js";const DistanceMeasurementAnalysisView2D = await $arcgis.import("@arcgis/core/views/2d/analysis/DistanceMeasurementAnalysisView2D.js");- Inheritance:
- DistanceMeasurementAnalysisView2D→
AnalysisView2D→ AnalysisView→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Represents the analysis view of an DistanceMeasurementAnalysis after it has been added to MapView.analyses.
DistanceMeasurementAnalysisView2D is responsible for the rendering, computing and interacting with DistanceMeasurementAnalysis. The result property contains the computed distance as well as the analytical method.
Use the place() method to initiate the interactive digitization of DistanceMeasurementAnalysis geometry.
To enable modification of an existing DistanceMeasurementAnalysis geometry, set the interactive property to true.
Use MapView.whenAnalysisView() to obtain the analysis view of an existing analysis. This is conceptually similar to how layer views are retrieved for layers using MapView.whenLayerView().
// Retrieve analysis view for analysisconst analysis = new DistanceMeasurementAnalysis();view.analyses.add(analysis); // add to the viewconst analysisView = await view.whenAnalysisView(analysis);Properties
result
- Type
- DistanceMeasurementResult | null | undefined
Result of the distance measurement analysis. The result object is created immediately and updated as the measurement is computed.
snappingOptions
- Type
- SnappingOptions
The SnappingOptions for sketching. It supports self and feature snapping.
unit
- Type
- SystemOrLengthUnit
Unit system (imperial, metric) or specific unit used for displaying the computed length in the view. This value is useful when DistanceMeasurementAnalysis.unit is not explicitly set on the analysis.
updating
- Type
- boolean
This property is true when the analysis is recomputing or updating its visualization.
Methods
| Method | Signature | Class |
|---|---|---|
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
place(options?: AbortOptions | null | undefined): Promise<DistanceMeasurementPlacementResult> | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
- Since
- ArcGIS Maps SDK for JavaScript 4.5
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); place
- Signature
-
place (options?: AbortOptions | null | undefined): Promise<DistanceMeasurementPlacementResult>
Starts an interactive placement operation to create a new DistanceMeasurementAnalysis.
The placement operation will finish when the user presses the escape key, double taps, or double clicks. To stop the placing programmatically, pass an abort signal as an argument when calling the method.
When placement operation completes successfully, the analysis will have a valid DistanceMeasurementAnalysis.geometry.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional options. | |
- Returns
- Promise<DistanceMeasurementPlacementResult>
A promise which resolves when the operation is completed successfully or rejected if it is canceled.
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
- Since
- ArcGIS Maps SDK for JavaScript 4.6
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});