require(["esri/analysis/Viewshed"], (Viewshed) => { /* code goes here */ });
import Viewshed from "@arcgis/core/analysis/Viewshed.js";
esri/analysis/Viewshed
Viewshed defines the geometry for a viewshed analysis. The viewshed is determined by a position, distance, orientation (defined by heading and tilt), and field of view angles.
const viewshed = new Viewshed({
observer: new Point({
spatialReference: {
latestWkid: 3857,
wkid: 102100
},
x: -9754426,
y: 5143111,
z: 330
}),
farDistance: 900,
heading: 64,
tilt: 84,
horizontalFieldOfView: 85,
verticalFieldOfView: 52
});
const viewshedAnalysis = new ViewshedAnalysis({
viewsheds: [viewshed],
});
view.analyses.add(viewshedAnalysis);
To create a view dome, set horizontalFieldOfView to 360, and verticalFieldOfView to 180.
Note that when placing viewsheds interactively, the viewshed is created with a 1.5 meter vertical offset from the scene. This behavior is subject to change in a future release.
- 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 | ||
The maximum distance from the observer in which to perform the viewshed analysis (in meters). | Viewshed | ||
References a feature from which the observer is internally offset, provided that its geometry faces are close enough to the observer. | Viewshed | ||
The compass heading of the observer's view direction (in degrees). | Viewshed | ||
The horizontal field of view (FOV) angle defines the width of the scope being analyzed (in degrees). | Viewshed | ||
A Point specifying the position the viewshed is calculated from. | Viewshed | ||
The tilt of the observer's view direction (in degrees). | Viewshed | ||
The vertical field of view (FOV) angle defines the height of the scope being analyzed (in degrees). | Viewshed |
Property Details
-
farDistance
PropertyfarDistance Number -
The maximum distance from the observer in which to perform the viewshed analysis (in meters).
-
feature
Propertyfeature FeatureReferenceSince: ArcGIS Maps SDK for JavaScript 4.31Viewshed since 4.30, feature added at 4.31. -
References a feature from which the observer is internally offset, provided that its geometry faces are close enough to the observer. It is used to ensure that the analysis results remain independent of changes in the level of detail of the scene geometry.
When creating viewsheds interactively, this property is populated automatically.
Note that you can assign client side graphics which will be taken into account accordingly. However, information about client side graphics will not be persisted and results in an empty reference after de-serialization.
-
heading
Propertyheading Number -
The compass heading of the observer's view direction (in degrees). A heading of zero points the viewshed to north and it increases as the viewshed rotates clockwise.
- Default Value:0
-
horizontalFieldOfView
PropertyhorizontalFieldOfView Number -
The horizontal field of view (FOV) angle defines the width of the scope being analyzed (in degrees). A value of 360 means the observer's horizontal FOV captures their entire surroundings. Values closer to 0 narrow the horizontal FOV in the direction of the heading.
- Default Value:45
-
A Point specifying the position the viewshed is calculated from.
-
tilt
Propertytilt Number -
The tilt of the observer's view direction (in degrees). A tilt of zero points the viewshed looking straight down and 90 degrees points it looking parallel to the surface.
- Default Value:90
-
verticalFieldOfView
PropertyverticalFieldOfView Number -
The vertical field of view (FOV) angle defines the height of the scope being analyzed (in degrees). This value can vary from 0 to 180. Values closer to 0 narrow the vertical FOV in the direction of the tilt.
- Default Value:45
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. | Viewshed | |
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.
-
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 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
-
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");