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 analysis = new SliceAnalysis({
shape: {
type: "plane", // autocasts as new SlicePlane()
position: {
type: "point",
x: -0.1,
y: 51.5
},
width: 50,
height: 50,
tilt: 45
},
tiltEnabled: true
});
view.analyses.add(slice);
SceneView.analyses can contain multiple slice analyses, but only one of these analyses can be active
at a time. When working with multiple slices, set the active
property of a slice view to true to occlude the parts of the 3D features that are in front of the slice plane.
When a slice view is activated, all other slice views are automatically deactivated.
view.whenAnalysisView(slice).then((sliceView) => {
sliceView.active = true;
});
To place the slice interactively in the view using positioning, scaling and rotation handles, it is recommended to use the Slice widget.
Constructors
-
new SliceAnalysis(properties)
-
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 |
|---|---|---|---|
| String | The name of the class. more details | Accessor | |
| SlicePlane | The shape used to slice elements in a 3D scene. more details | SliceAnalysis | |
| String | For SliceAnalysis the type is always "slice". more details | SliceAnalysis |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
shape SlicePlaneautocast
-
The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.
-
type Stringreadonly
-
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. more details | Accessor | ||
| this | Creates a deep clone of this object. more details | SliceAnalysis | |
| 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)inheritedSince: ArcGIS API for JavaScript 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 } ); // Handle gets removed when the object is destroyed. this.addHandles(handle);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.
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
Since: ArcGIS API for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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)inheritedSince: ArcGIS API for JavaScript 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");