import DirectLineMeasurementAnalysisView3D from "@arcgis/core/views/3d/analysis/DirectLineMeasurementAnalysisView3D.js";const DirectLineMeasurementAnalysisView3D = await $arcgis.import("@arcgis/core/views/3d/analysis/DirectLineMeasurementAnalysisView3D.js");- Inheritance:
- DirectLineMeasurementAnalysisView3D→
AnalysisView3D→ AnalysisView→ Accessor
Represents the analysis view of a DirectLineMeasurementAnalysis after it has been added to SceneView.analyses.
The DirectLineMeasurementAnalysisView3D is responsible for rendering a DirectLineMeasurementAnalysis using custom visualizations.
It allows to create a new analysis interactively using the place() method, query the measured result, or make an existing analysis editable by enabling the interactive property.
The view for an analysis can be retrieved using SceneView.whenAnalysisView() similar to how layer views are retrieved for layers using SceneView.whenLayerView().
// retrieve analysis view for analysisconst analysis = new DirectLineMeasurementAnalysis();view.analyses.add(analysis); // add to the scene viewconst analysisView = await view.whenAnalysisView(analysis);Things to consider:
Snapping is enabled by default. This can be temporarily disabled by holding the CTRL key.
Layer types currently supported for snapping are: FeatureLayer, GraphicsLayer (except Mesh geometries),
GeoJSONLayer, WFSLayer, CSVLayer,
3D Object SceneLayer, and BuildingSceneLayer.
Properties
| Property | Type | Class |
|---|---|---|
analysis readonly | | |
declaredClass readonly inherited | ||
| | ||
| | ||
type readonly | "direct-line-measurement-view-3d" | |
| |
interactive
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Enables interactivity for the associated analysis. When set to true, manipulators will be displayed,
allowing users to click and drag to edit the analysis if it has a valid
DirectLineMeasurementAnalysis.startPoint and
DirectLineMeasurementAnalysis.endPoint.
This property is automatically set to true when the analysis is assigned to a
Direct Line Measurement 3D component.
- Default value
- false
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<DirectLineMeasurementPlacementResult> | | |
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<DirectLineMeasurementPlacementResult>
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Starts the interactive placement of a direct line measurement.
If the analysis does not have a DirectLineMeasurementAnalysis.startPoint and DirectLineMeasurementAnalysis.endPoint yet, the method allows placing the start and end points interactively in the view. If the analysis already has a measurement, clicking in the view will remove it and start the placement of new start and end points.
The placement operation will finish when the user presses the escape key. To stop the placing programmatically, pass an abort signal as an argument when calling the method.
Calling this method sets interactive to true.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional options. | |
- Returns
- Promise<DirectLineMeasurementPlacementResult>
A promise which resolves when the operation is completed successfully or rejected if it is canceled.
Example
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 pointabortController.abort(); 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});