import SliceAnalysis from "@arcgis/core/analysis/SliceAnalysis.js";
const SliceAnalysis = await $arcgis.import("@arcgis/core/analysis/SliceAnalysis.js");
@arcgis/core/analysis/SliceAnalysis
SliceAnalysis can be used to programmatically create a plane that slices through 3D features in a 3D SceneView.
A slice takes a SlicePlane
as an input, which can be set through the shape property. If the shape has a tilt angle other than 0
, the angle
is only considered if the tiltEnabled property is set to true
.
const sliceAnalysis = new SliceAnalysis({
shape: new SlicePlane({
position: new Point({ }),
width: 50,
height: 50,
tilt: 45
}),
tiltEnabled: true
});
view.analyses.add(sliceAnalysis);
SceneView.analyses can contain multiple slice analyses, but only one of
them can be active at a time. When working with multiple slices, set the active
property of a slice analysis view to true
to occlude the parts of the 3D features that are in front of the slice
plane. When a slice analysis view is activated, all other slice analysis views are automatically deactivated.
const sliceAnalysisView = await view.whenAnalysisView(sliceAnalysis);
// make the slice active in the view (only one slice can be active at a time)
sliceAnalysisView.active = true;
To place a slice interactively, use the SliceAnalysisView3D.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();
Similarly, to interactively exclude layers from the slicing, use the SliceAnalysisView3D.pickLayerToExclude() method.
const abortController = new AbortController();
try {
await analysisView.pickLayerToExclude({ signal: abortController.signal });
} catch (error) {
if (error.name === "AbortError") {
console.log("Picking excluded layers operation was cancelled.");
}
}
// cancel the operation at some later point
abortController.abort();
Use the Slice component to display a user interface for the slice analysis. The component allows users to interactively place a slice and exclude layers from the analysis.
Known Limitations
- This analysis is only supported in a 3D SceneView.
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 flag that indicates whether the ground surface should be excluded from the slice analysis. | SliceAnalysis | ||
A collection of layers that should be excluded from the slice analysis. | SliceAnalysis | ||
A user settable identifier for the analysis. | Analysis | ||
The origin of the analysis. | Analysis | ||
The shape used to slice elements in a 3D scene. | SliceAnalysis | ||
Whether the shape supports a tilt angle or not. | SliceAnalysis | ||
The type of analysis. | SliceAnalysis | ||
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. | SliceAnalysis |
Property Details
-
excludeGroundSurface
excludeGroundSurface Boolean
Since: ArcGIS Maps SDK for JavaScript 4.33SliceAnalysis since 4.23, excludeGroundSurface added at 4.33. -
A flag that indicates whether the ground surface should be excluded from the slice analysis.
- Default Value:false
-
excludedLayers
excludedLayers Collection<(Layer|BuildingComponentSublayer)>autocast
Since: ArcGIS Maps SDK for JavaScript 4.33SliceAnalysis since 4.23, excludedLayers added at 4.33. -
A collection of layers that should be excluded from the slice analysis.
-
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.
-
shape
shape SlicePlane |null |undefinedautocast
-
The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.
-
tiltEnabled
tiltEnabled Boolean
-
Whether the shape supports a tilt angle or not. If set to true, the SlicePlane.tilt angle is respected. By default it is set to false, so the tilt value of the shape is not taken into consideration.
- Default Value:false
-
type
type Stringreadonly
-
The type of analysis. For slice analysis, this is always "slice".
For SliceAnalysis the type is always "slice".
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
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
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 AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
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
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
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");