import ViewshedAnalysis from "@arcgis/core/analysis/ViewshedAnalysis.js";
const ViewshedAnalysis = await $arcgis.import("@arcgis/core/analysis/ViewshedAnalysis.js");
@arcgis/core/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: new Point({ }),
farDistance: 900,
heading: 64,
tilt: 84,
horizontalFieldOfView: 85,
verticalFieldOfView: 52
});
const viewshedAnalysis = new ViewshedAnalysis({
viewsheds: [viewshed],
});
// add the analysis to the view
view.analyses.add(viewshedAnalysis);
To add a viewshed interactively, use the ViewshedAnalysisView3D.place() method.
const abortController = new AbortController();
try {
// get a view for the analysis
const analysisView = await view.whenAnalysisView(viewshedAnalysis);
// start placing a new viewshed interactively
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();
To edit existing viewsheds interactively, set the
ViewshedAnalysisView3D.interactive property
true
and select a viewshed by hovering and clicking on their field-of-view manipulators.
// allow existing viewsheds in the analysis to be selected and edited
analysisView.interactive = true;
A ViewshedAnalysis can be persisted in a WebScene as part of a ViewshedLayer.
Known Limitations
- This analysis 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 | ||
A user settable identifier for the analysis. | Analysis | ||
The origin of the analysis. | Analysis | ||
The type of analysis. | ViewshedAnalysis | ||
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. | ViewshedAnalysis | ||
A list of viewsheds. | ViewshedAnalysis |
Property Details
-
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.
-
type
type Stringreadonly
-
The type of analysis. For viewshed analysis, this is always "viewshed".
For ViewshedAnalysis the type is always "viewshed".
-
valid
valid Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33ViewshedAnalysis since 4.30, valid added at 4.33. -
Indicates whether the analysis is ready to be computed and interacted with in the view. It requires each of the viewsheds to be valid, that is, to have an observer with a position and a far distance greater than 0. If the analysis has no viewshed, it is considered valid.
-
viewsheds
viewsheds 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. | 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
-
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 Accessor -
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
-
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");