DimensionAnalysis | API Reference | ArcGIS Maps SDK for JavaScript 4.30

DimensionAnalysis enables the creation and display of measurement annotations for lengths and distances in a 3D SceneView.

The analysis can contain multiple dimensions. These can be created interactively or programmatically, and the analysis can be added directly to either SceneView.analyses or to the DimensionLayer.source in a SceneView.map.

// create analysis with dimensions
const dimensionAnalysis = new DimensionAnalysis({
   dimensions: [
     new LengthDimension({
       startPoint: new Point({ }),
       endPoint: new Point({ })
     })
   ],
   style: new DimensionSimpleStyle({
     color: "white"
   }),
});
// add the analysis to the view
view.analyses.push(dimensionAnalysis);

Use the DimensionAnalysisView to retrieve the analysis results.

// retrieve measured results from analysis view
view.whenAnalysisView(dimensionAnalysis).then(dimensionAnalysisView => {
  const results = dimensionAnalysisView.results;
});

To start adding length dimensions interactively to the analysis, use the DimensionAnalysisView.createLengthDimensions() method.

view.whenAnalysisView(dimensionAnalysis).then(dimensionAnalysisView => {
  dimensionAnalysisView.createLengthDimensions();
});

DimensionAnalysis can only be saved to a WebScene or added to Slides as part of a DimensionLayer.

Known Limitations

DimensionAnalysis is only supported in a 3D SceneView.

See also

Constructors

DimensionAnalysis Constructor new DimensionAnalysis(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 Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Collection<LengthDimension>	A list of dimensions.	DimensionAnalysis
DimensionSimpleStyle	The style defines how the dimension objects of this analysis are displayed.	DimensionAnalysis

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

dimensions Property dimensions Collection<LengthDimension>autocast

A list of dimensions.

style Property style DimensionSimpleStyleautocast

The style defines how the dimension objects of this analysis are displayed.

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
this	Creates a deep clone of this object.	DimensionAnalysis
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

clone Method clone(){this}

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

Type	Description
this	A deep clone of the class instance that invoked this method.

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");