ViewshedAnalysis

ESM: import ViewshedAnalysis from "@arcgis/core/analysis/ViewshedAnalysis.js";
CDN: const ViewshedAnalysis = await $arcgis.import("@arcgis/core/analysis/ViewshedAnalysis.js");
Class: @arcgis/core/analysis/ViewshedAnalysis
Inheritance: ViewshedAnalysisAnalysisAccessor
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.

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

ViewshedAnalysis

Constructor
new ViewshedAnalysis(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
Show inherited properties Hide inherited properties
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

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

id

Inherited
Property
id String
Inherited from Analysis

A user settable identifier for the analysis. A unique value is automatically generated when the analysis is created if it is not set explicitly during construction.

origin

Inherited
Property
origin 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

Property
type Stringreadonly

The type of analysis. For viewshed analysis, this is always "viewshed".

For ViewshedAnalysis the type is always "viewshed".

uid

Inherited
Property
uid Stringreadonly
Inherited from Analysis
Since: ArcGIS Maps SDK for JavaScript 4.33 Analysis since 4.33, uid added at 4.33.

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

valid

Property
valid Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 ViewshedAnalysis 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

Property
viewsheds Collection<Viewshed>autocast
Autocasts from Object[]

A list of viewsheds.

Method Overview

Show inherited methods Hide inherited methods
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

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

clone

Inherited
Method
clone(){this}
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.

Returns
Type Description
this A deep clone of the class instance that invoked this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.