require(["esri/analysis/ViewshedAnalysis"], (ViewshedAnalysis) => { /* code goes here */ });
import ViewshedAnalysis from "@arcgis/core/analysis/ViewshedAnalysis.js";
esri/analysis/ViewshedAnalysis
ViewshedAnalysis enables the creation and display of viewshed and view dome type of visibility analysis in a 3D SceneView.
The analysis can contain multiple viewsheds. These can be created interactively or programmatically, and the analysis can be added directly to SceneView.analyses or to the ViewshedLayer.source in a SceneView.map.
const viewshed = new Viewshed({
observer: {
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 start adding viewsheds interactively to the analysis, use the ViewshedAnalysisView.createViewsheds() method.
view.whenAnalysisView(viewshedAnalysis).then((viewshedAnalysisView) => {
viewshedAnalysisView.createViewsheds();
});
ViewshedAnalysis can be persisted in a WebScene as part of a ViewshedLayer.
Known Limitations
- ViewshedAnalysis is only supported in a 3D SceneView.
- The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.
- 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 | ||
| For ViewshedAnalysis the type is always "viewshed". | ViewshedAnalysis | ||
A list of viewsheds. | ViewshedAnalysis |
Property Details
-
type
Propertytype Stringreadonly -
For ViewshedAnalysis the type is always "viewshed".
-
viewsheds
Propertyviewsheds Collection<Viewshed>autocast -
A list of viewsheds.
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. | ViewshedAnalysis | |
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");