import DimensionAnalysis from "@arcgis/core/analysis/DimensionAnalysis.js";
const DimensionAnalysis = await $arcgis.import("@arcgis/core/analysis/DimensionAnalysis.js");
@arcgis/core/analysis/DimensionAnalysis
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 DimensionAnalysisView3D to retrieve the analysis results.
// retrieve measured results from the analysis view
const analysisView = await view.whenAnalysisView(dimensionAnalysis);
const results = dimensionAnalysisView.results;
To place a length dimension interactively, use the DimensionAnalysisView3D.place() method.
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 point
abortController.abort();
To edit existing dimensions interactively, set the
DimensionAnalysisView3D.interactive property
true
and select a dimension by hovering and clicking on their offset manipulator.
// allow existing dimensions in the analysis to be selected and edited
analysisView.interactive = true;
DimensionAnalysis can be saved to a WebScene as part of a DimensionLayer.
Known Limitations
- This analysis is only supported in a 3D SceneView.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
A list of dimensions. | DimensionAnalysis | ||
A user settable identifier for the analysis. | Analysis | ||
The origin of the analysis. | Analysis | ||
The style defines how the dimension objects of this analysis are displayed. | DimensionAnalysis | ||
The type of analysis. | DimensionAnalysis | ||
An automatically generated unique identifier assigned to the instance. | Analysis | ||
Indicates whether the analysis is ready to be computed and interacted with in the view. | DimensionAnalysis |
Property Details
-
dimensions
dimensions Collection<LengthDimension>autocast
-
A list of dimensions.
-
origin
InheritedPropertyorigin AnalysisOriginWebScene |null |undefinedautocast
Inherited from Analysis -
The origin of the analysis. The origin can be of type
web-scene
when the analysis was applied from the WebScene.initialViewProperties or a Slide.
-
style
style DimensionSimpleStyleautocast
-
The style defines how the dimension objects of this analysis are displayed.
-
type
type Stringreadonly
-
The type of analysis. For dimension analysis, this is always "dimension".
For DimensionAnalysis the type is always "dimension".
-
valid
valid Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33DimensionAnalysis since 4.25, valid added at 4.33. -
Indicates whether the analysis is ready to be computed and interacted with in the view. It requires each of the dimensions to be valid, that is, to have both a start and end point If the analysis has no dimension, it is considered valid.
Method Overview
Name | 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. | Analysis | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Inherited from Analysis
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");