Viewshed

AMD: require(["esri/analysis/Viewshed"], (Viewshed) => { /* code goes here */ });
ESM: import Viewshed from "@arcgis/core/analysis/Viewshed.js";
Class: esri/analysis/Viewshed
Inheritance: ViewshedAccessor
Since: ArcGIS Maps SDK for JavaScript 4.30

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

Viewshed

Constructor
new Viewshed(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

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

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

farDistance

Property
farDistance Number

The maximum distance from the observer in which to perform the viewshed analysis (in meters).

feature

Property
feature FeatureReference
Since: ArcGIS Maps SDK for JavaScript 4.31 Viewshed 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

Property
heading 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

Property
horizontalFieldOfView 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

observer

Property
observer Pointautocast

A Point specifying the position the viewshed is calculated from.

tilt

Property
tilt 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

Property
verticalFieldOfView 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

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.

Viewshed

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

Method
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
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");

Type Definitions

FeatureReference

Type Definition
FeatureReference
Properties

Reference to a layer.

Specification

The layer id.

objectIdField String|null|undefined
optional

The object id field.

attributes Object

Feature attributes.

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