ViewshedAnalysis | References | ArcGIS Maps SDK for JavaScript

import ViewshedAnalysis from "@arcgis/core/analysis/ViewshedAnalysis.js";

Inheritance:: ViewshedAnalysis→Analysis→Accessor

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ViewshedAnalysisProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`id` readonly inherited	`string`	Analysis
`origin` inherited	`AnalysisOriginWebScene \| null \| undefined`	Analysis
`type` readonly	`"viewshed"`
`uid` readonly inherited	`string`	IdentifiableMixin
`valid` readonly	`boolean`
`viewsheds`	`Collection<Viewshed>`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

id

readonlyinherited Property

Type: 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

autocast inherited Property

Type: AnalysisOriginWebScene | null | undefined

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

readonly Property

Type: "viewshed"

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

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

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

readonly Property

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, 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

autocast Property

Type: Collection<Viewshed>

A list of viewsheds.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clear`	`clear(): void`
`clone` inherited	`clone(): this`	ClonableMixin
`equals` inherited	`equals(other: this): boolean`	Analysis
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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	`any`	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.

clear

Method

Signature: clear (): void

Since: ArcGIS Maps SDK for JavaScript 5.0

Clears the analysis by removing all viewsheds.

Returns: void

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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

inherited Method

Signature: equals (other: this): boolean

Inherited from: Analysis

Since: ArcGIS Maps SDK for JavaScript 5.0

Compares this analysis with another analysis to determine whether they are equivalent.

Parameters

Parameter	Type	Description	Required
other	`this`	The other analysis to compare against.

Returns: boolean
true if the analyses are equivalent and false otherwise.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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.