DimensionAnalysis

AMD: require(["esri/analysis/DimensionAnalysis"], (DimensionAnalysis) => { /* code goes here */ });
ESM: import DimensionAnalysis from "@arcgis/core/analysis/DimensionAnalysis";
Class: esri/analysis/DimensionAnalysis
Inheritance: DimensionAnalysis Accessor
Since: ArcGIS API for JavaScript 4.25

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

The dimension objects can be created interactively or programmatically and added either directly to 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, make the DimensionAnalysisView interactive and use the DimensionAnalysisView.createLengthDimensions() method.

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

Only the DimensionAnalysis on a DimensionLayer can be saved to a WebScene or added to Slides.

Known Limitations

  • DimensionAnalysis is only supported in a 3D SceneView.
See also

Constructors

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
Name Type Summary Class
String

The name of the class.

more details
Accessor
Collection<LengthDimension>

A list of dimensions.

more details
DimensionAnalysis
DimensionSimpleStyle

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

more details
DimensionAnalysis

Property Details

declaredClass Stringreadonly inherited

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

A list of dimensions.

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
this

Creates a deep clone of this object.

more details
DimensionAnalysis
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(){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(groupKey){Boolean}inherited

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(groupKey)inherited

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.