▾
import ViewshedAnalysisView3D from "@arcgis/core/views/3d/analysis/ViewshedAnalysisView3D.js";const ViewshedAnalysisView3D = await $arcgis.import("@arcgis/core/views/3d/analysis/ViewshedAnalysisView3D.js");- Inheritance
- ViewshedAnalysisView3D→
AnalysisView3D→ AnalysisView→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.30
Represents the analysis view of a ViewshedAnalysis after it has been added to SceneView.analyses.
The ViewshedAnalysisView3D is responsible for rendering a ViewshedAnalysis using custom visualizations.
It allows to create new viewsheds interactively using the place() method, or to make existing viewsheds selectable and editable by enabling the interactive property. To select a viewshed, hover and click on its observer.
The view for an analysis can be retrieved using SceneView.whenAnalysisView() similar to how layer views are retrieved for layers using SceneView.whenLayerView().
// create new analysis and add it to the viewconst analysis = new ViewshedAnalysis();view.analyses.add(analysis);
// retrieve analysis viewconst analysisView = await view.whenAnalysisView(analysis);Things to consider:
- 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
Properties
| Property | Type | Class |
|---|---|---|
| readonly | | |
| readonly inherited | ||
| | ||
| | ||
| readonly | "viewshed-view-3d" | |
| |
analysis
- Type
- ViewshedAnalysis
The viewshed analysis object associated with the analysis view.
interactive
- Type
- boolean
Enables interactivity for the analysis.
When set to true and the analysis includes any valid ViewshedAnalysis.viewsheds,
they become selectable and editable.
Viewsheds can be removed with the Delete key.
- Default value
- false
selectedViewshed
The viewshed currently selected for interactive editing.
When interactive is true, any viewshed in the
analysis can be selected
and its properties can be edited by interacting with the manipulators in the view.
Methods
| Method | Signature | Class |
|---|---|---|
| createViewsheds(options?: ViewshedPlacementOptions | null | undefined): Promise<void> | | |
| inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
| inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
| inherited | isFulfilled(): boolean | |
| inherited | isRejected(): boolean | |
| inherited | isResolved(): boolean | |
| inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
| place(options?: ViewshedPlacementOptions | null | undefined): Promise<ViewshedPlacementResult> | | |
| inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
createViewsheds
- Signature
-
createViewsheds (options?: ViewshedPlacementOptions | null | undefined): Promise<void>
Starts the interactive creation of new viewsheds and adds them to the analysis.
The first click in the scene places the observer point and the second sets the viewshed's orientation and distance.
The creation process will finish when the user double-clicks the mouse or presses the escape key. To stop the creation programmatically, pass an abort signal as an argument when calling the method.
This method is similar to the place() method, but it allows to create multiple viewsheds in a row.
By default, the observer is created at absolute height. Optionally, by specifying the options of the method, you can change the elevation info.
Calling this method sets interactive to true.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional placement options, including elevation information and an abort signal. | |
- Example
- const abortController = new AbortController();try {await analysisView.createViewsheds({signal: abortController.signal,// optional elevation infoelevationInfo: { mode: "relative-to-ground", offset: 1.5 },});} catch (error) {if (error.name === "AbortError") {console.log("Creation operation was cancelled.");}}// cancel the creation operation at some later pointabortController.abort();
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify whether the promise has been fulfilled (either resolved or rejected).
- Returns
- boolean
Whether the promise has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify whether the promise has been rejected.
- Returns
- boolean
Whether the promise has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify whether the promise has resolved.
- Returns
- boolean
Whether the promise has resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
- Example
- view.on("click", function(event){// event is the event handle returned after the event fires.console.log(event.mapPoint);});
place
- Signature
-
place (options?: ViewshedPlacementOptions | null | undefined): Promise<ViewshedPlacementResult>
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Starts the interactive placement of a single viewshed, adding it to the analysis.
The first click in the scene places the observer point and the second sets the viewshed's orientation and distance.
The placement operation will finish when the user presses the escape key. To stop the placing programmatically, pass an abort signal as an argument when calling the method.
By default, the observer is created at absolute height. Optionally, by specifying the options of the method, you can change the elevation info.
Calling this method sets interactive to true.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional options. | |
- Returns
- Promise<ViewshedPlacementResult>
A promise which resolves when the operation is completed successfully or rejected if it is canceled.
- Example
- const abortController = new AbortController();try {await analysisView.place({signal: abortController.signal,// optional elevation infoelevationInfo: { mode: "relative-to-ground", offset: 1.5 },});} catch (error) {if (error.name === "AbortError") {console.log("Placement operation was cancelled.");}}// cancel the placement operation at some later pointabortController.abort();
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be used with an instance of this class. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled function executes when the promise resolves. The
onRejected function executes if the promise is rejected.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
- Example
- // Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){// This function will execute once the promise is resolved}, function(error){// This function will execute if the promise is rejected due to an error});