import DimensionAnalysisView3D from "@arcgis/core/views/3d/analysis/DimensionAnalysisView3D.js";const DimensionAnalysisView3D = await $arcgis.import("@arcgis/core/views/3d/analysis/DimensionAnalysisView3D.js");- Inheritance:
- DimensionAnalysisView3D→
AnalysisView3D→ AnalysisView→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Represents the analysis view of a DimensionAnalysis after it has been added to SceneView.analyses.
The DimensionAnalysisView3D is responsible for rendering a DimensionAnalysis using custom visualizations.
It allows to create new dimensions interactively using the place() method, query measured results, or to make existing dimensions selectable and editable by enabling the interactive property. To select a dimension, hover and click on its offset manipulator.
The view for an analysis can be retrieved using SceneView.whenAnalysisView() similar to how layer views are retrieved for layers using SceneView.whenLayerView().
// create new analysis and add it to the viewconst dimensionAnalysis = new DimensionAnalysis();view.analyses.add(dimensionAnalysis);
// retrieve analysis view for the analysisconst dimensionAnalysisView = await view.whenAnalysisView(dimensionAnalysis);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.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
analysis readonly | | |
declaredClass readonly inherited | ||
| | ||
results readonly | | |
| | ||
type readonly | "dimension-view-3d" | |
| |
analysis
- Type
- DimensionAnalysis
The dimension analysis object associated with the analysis view.
interactive
- Type
- boolean
Enables interactivity for the analysis. When set to true and the analysis includes any
valid DimensionAnalysis.dimensions, they become selectable and editable.
- Default value
- false
results
Results for each dimension in the analysis.
The order of results matches the order of DimensionAnalysis.dimensions, so if the index of the dimension is known the collection can be indexed directly:
const dimensionAnalysisView = await view.whenAnalysisView(dimensionAnalysis);const result = dimensionAnalysisView.results.at(dimensionIdx);Given a dimension object, the results collection can also be searched:
const result = dimensionAnalysisView.results.find((result) => result.dimension === dimensionObject); selectedDimension
- Type
- LengthDimension | null | undefined
The selected dimension. If interactive is true, any dimension in the
analysis can be selected by clicking on it in the view. As long as interactive
remains true, the properties of the selected dimension can be edited by interacting with
manipulators in the view.
Methods
| Method | Signature | Class |
|---|---|---|
createLengthDimensions(options?: AbortOptions | null | undefined): Promise<void> | | |
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<DimensionPlacementResult> | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
createLengthDimensions
- Signature
-
createLengthDimensions (options?: AbortOptions | null | undefined): Promise<void>
Starts the interactive creation of new dimensions and adds them to the analysis.
The first click places start point and the second sets end point.
The creation process will finish when the user double-clicks the mouse or presses the escape key. To stop the creation programmatically, pass an abort signal as an argument when calling the method.
This method is similar to the place() method, but it allows to create multiple dimensions in a row.
Calling this method sets interactive to true.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional options. | |
Example
const abortController = new AbortController();
try { await analysisView.createLengthDimensions({ signal: abortController.signal });} catch (error) { if (error.name === "AbortError") { console.log("Placement operation was cancelled."); }}
// cancel the placement operation at some later pointabortController.abort(); emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
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<DimensionPlacementResult>
Starts the interactive placement of a single dimension, adding it to the analysis.
The first click places start point and the second sets end point.
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<DimensionPlacementResult>
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>
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});