▾
import ViewshedAnalysis from "@arcgis/core/analysis/ViewshedAnalysis.js";const ViewshedAnalysis = await $arcgis.import("@arcgis/core/analysis/ViewshedAnalysis.js");- Since
- ArcGIS Maps SDK for JavaScript 4.30
ViewshedAnalysis enables the creation and display of viewshed and view dome type of visibility analysis in a 3D SceneView.
Create a new instance of ViewshedAnalysis and add it to SceneView.analyses. The analysis may contain multiple viewsheds. The viewsheds can be created programmatically or interactively.
const viewshed = new Viewshed({ observer: new Point({ }), farDistance: 900, heading: 64, tilt: 84, horizontalFieldOfView: 85, verticalFieldOfView: 52});const analysis = new ViewshedAnalysis({ viewsheds: [viewshed],});
// add the analysis to the viewview.analyses.add(analysis);The analysis colors the areas visible to the observer as green and occluded parts as red.
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(analysis);
// 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 pointabortController.abort();To edit any existing viewsheds interactively, set the
ViewshedAnalysisView3D.interactive property to true and
select a viewshed by clicking on its observer. Manipulators for editing the observer's position
and other parameters of the viewshed will then be displayed.
// allow existing viewsheds in the analysis to be selected and editedanalysisView.interactive = true;The viewshed analysis can be persisted in a WebScene as part of a ViewshedLayer:
// create viewshed layer containing the analysisconst viewshedLayer = new ViewshedLayer({ source: analysis});
// add the layer to the mapview.map.add(viewshedLayer);Things to consider:
- 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.
- Snapping, tooltips, display units, and input units used during interactive placement and editing are inherited from
ViewOptions.
- Snapping is enabled by default. This can be temporarily disabled by holding the
CTRLkey. - Layer types currently supported for snapping are: FeatureLayer, GraphicsLayer (except Mesh geometries), GeoJSONLayer, WFSLayer, CSVLayer, 3D Object SceneLayer, and BuildingSceneLayer.
- Snapping is enabled by default. This can be temporarily disabled by holding the
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| readonly inherited | ||
| readonly inherited | ||
| inherited | ||
| readonly | "viewshed" | |
| readonly inherited | ||
| readonly | | |
| |
origin
- Type
- AnalysisOriginWebScene | null | undefined
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.
uid
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 4.33
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
valid
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 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, the Viewshed.observer needs to be set and the Viewshed.farDistance to be greater than 0. If the analysis has no viewshed, it is considered valid.
Methods
| Method | Signature | Class |
|---|---|---|
| inherited static | fromJSON(json: any): any | |
| clear(): void | | |
| inherited | clone(): this | |
| inherited | equals(other: this): boolean | |
| inherited | toJSON(): any |
fromJSON
- Signature
-
fromJSON (json: any): any
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 json
parameter 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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A 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
- any
Returns a new instance of this class.
clone
- Signature
-
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.
- Returns
- this
A deep clone of the class instance that invoked this method.
equals
- Signature
-
equals (other: this): boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Compares this analysis with another analysis to determine whether they are equivalent.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.