require(["esri/analysis/SlicePlane"], (SlicePlane) => { /* code goes here */ });
import SlicePlane from "@arcgis/core/analysis/SlicePlane.js";
esri/analysis/SlicePlane
Provides the shape definition of a slice plane for a Slice widget or SliceAnalysis. The slice plane is defined by a position, heading and tilt. Its size is defined by width and height.
When working with the Slice widget, the plane can be set or retrieved from the shape property of the SliceViewModel:
let sliceWidget = new Slice({
view: view
});
sliceWidget.viewModel.shape = new SlicePlane({
position: new Point({
latitude: 34.06007911204149,
longitude: -117.1867758409791,
z: 416.852
}),
// a 30 degree angle between the slice plane and the ground plane
tilt: 30,
width: 32,
height: 32,
// the height axis of the plane is oriented north
heading: 0
});
sliceWidget.viewModel.start();
view.ui.add(sliceWidget, "top-right");
When working with a SliceAnalysis, the plane can be set or retrieved from the shape property of the analysis.
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 | ||
The heading angle (in degrees) of the slice plane. | SlicePlane | ||
The height of the slice plane. | SlicePlane | ||
A point specifying the position of the center of the plane. | SlicePlane | ||
The tilt angle (in degrees) of the slice plane. | SlicePlane | ||
The string value representing the type of the slice shape. | SlicePlane | ||
The width of the slice plane. | SlicePlane |
Property Details
-
heading
Propertyheading Number -
The heading angle (in degrees) of the slice plane.
- Default Value:0
-
height
Propertyheight Number -
The height of the slice plane. The unit is derived from the SpatialReference of the position.
- Default Value:10
-
A point specifying the position of the center of the plane.
-
tilt
Propertytilt Number -
The tilt angle (in degrees) of the slice plane.
- Default Value:0
-
type
Propertytype Stringreadonly -
The string value representing the type of the slice shape.
For SlicePlane the type is always "plane".
-
width
Propertywidth Number -
The width of the slice plane. The unit is derived from the SpatialReference of the position.
- Default Value:10
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. | SlicePlane | |
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | SlicePlane | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | SlicePlane |
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.
-
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.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns
-
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 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"); }
-
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");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.