import LineOfSightAnalysisView3D from "@arcgis/core/views/3d/analysis/LineOfSightAnalysisView3D.js";
Inheritance
LineOfSightAnalysisView3D→AnalysisView3D→AnalysisView→Accessor

Represents the analysis view of a LineOfSightAnalysis after it has been added to SceneView.analyses.

The LineOfSightAnalysisView3D is responsible for rendering a LineOfSightAnalysis using custom visualizations.

It allows to create an observer and targets interactively using the place() method, query analysis results, or make an existing analysis editable by enabling the interactive property.

The view for an analysis can be retrieved using SceneView.whenAnalysisView() similar to how layer views are retrieved for layers using SceneView.whenLayerView().

// retrieve analysis view for analysis
const analysis = new LineOfSightAnalysis();
view.analyses.add(analysis); // add to the view
const analysisView = await view.whenAnalysisView(analysis);

Things to consider:

See also

Properties

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

analysis

readonly Property
Type
LineOfSightAnalysis
Since
ArcGIS Maps SDK for JavaScript 4.24

The line of sight analysis object associated with the analysis view.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

interactive

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 4.24

Enables interactivity for the analysis. When set to true, and the analysis includes a valid LineOfSightAnalysis.observer and any LineOfSightAnalysis.targets, they become selectable and editable.

Targets can be removed by right-clicking on them or with the Delete key. The observer and the last target cannot be deleted interactively.

This property is automatically set to true when the analysis is assigned to a Line Of Sight component.

Default value
false

results

readonly Property
Type
Collection<LineOfSightAnalysisResult | null | undefined>

Analysis results for each target.

The order of results matches the order of targets, so if the index of the target is known the collection can be indexed directly:

const analysisView = await view.whenAnalysisView(analysis);
const result = analysisView.results.at(targetIdx);

Given a target object, the results collection can also be searched:

const result = analysisView.results.find((result) => result.target === targetObject);

selectedItem

readonly Property
Type
LineOfSightAnalysisObserver | LineOfSightAnalysisTarget | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.2

The observer or target currently selected for interactive editing.

When interactive is true, any observer or target in the analysis can be selected and its properties can be edited by interacting with the manipulators in the view.

Use the item's type property to determine whether it is an observer or a target.

Example
const analysisView = await view.whenAnalysisView(analysis);
analysisView.interactive = true;
reactiveUtils.watch(() => analysisView.selectedItem, (item) => {
if (item?.type === "observer") {
const observer = item; // LineOfSightAnalysisObserver
console.log("Selected observer:", observer.position);
} else if (item?.type === "target") {
const target = item; // LineOfSightAnalysisTarget
console.log("Selected target:", target.position);
}
});

type

readonly Property
Type
"line-of-sight-view-3d"
Since
ArcGIS Maps SDK for JavaScript 4.24

The analysis view type.

visible

autocast Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 4.24

When true, the analysis is visualized in the view.

Methods

MethodSignatureClass
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
on
inherited
on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
place(options?: LineOfSightPlacementOptions | null | undefined): Promise<LineOfSightPlacementResult>
inherited
when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

emit

inherited Method
Signature
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
Type parameters
<Type extends EventNames<this>>
Inherited from: EventedMixin
Since
ArcGIS Maps SDK for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

ParameterTypeDescriptionRequired
type
Type

The name of the event.

event
this["@eventTypes"][Type]

The event payload.

Returns
boolean

true if a listener was notified

hasEventListener

inherited Method
Signature
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
Type parameters
<Type extends EventNames<this>>
Inherited from: EventedMixin

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameters

ParameterTypeDescriptionRequired
type
Type

The name of the event.

Returns
boolean

Returns true if the class supports the input event.

isFulfilled

inherited Method
Signature
isFulfilled (): boolean
Inherited from: EsriPromiseMixin

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

inherited Method
Signature
isRejected (): boolean
Inherited from: EsriPromiseMixin

isRejected() may be used to verify whether the promise has been rejected.

Returns
boolean

Whether the promise has been rejected.

isResolved

inherited Method
Signature
isResolved (): boolean
Inherited from: EsriPromiseMixin

isResolved() may be used to verify whether the promise has resolved.

Returns
boolean

Whether the promise has resolved.

on

inherited Method
Signature
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
Type parameters
<Type extends EventNames<this>>
Inherited from: EventedMixin

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

ParameterTypeDescriptionRequired
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).

PropertyTypeDescription
removeFunctionWhen 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

Method
Signature
place (options?: LineOfSightPlacementOptions | null | undefined): Promise<LineOfSightPlacementResult>
Since
ArcGIS Maps SDK for JavaScript 4.33

Starts the interactive placement of an observer and targets on the analysis.

If the analysis does not have a valid observer yet, this method will allow placing an observer, which can be followed by zero or more targets. Otherwise, if it already has a valid observer, it will allow placing targets. An observer is valid when it has a position. Placing an observer without any targets is a productive operation.

The placement operation will finish when the user presses the escape key. Pressing escape after placing an observer or target finalizes a productive operation. Pressing escape before a valid observer is placed rejects the promise. To stop the placing programmatically, pass an abort signal as an argument when calling the method. The promise resolves when the operation is productive, i.e. an observer or any targets were added. Otherwise, if nothing was added or signal was aborted, the promise is rejected.

By default, the observer and targets are 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

ParameterTypeDescriptionRequired
options

An object specifying additional placement options, including elevation information and an abort signal.

Returns
Promise<LineOfSightPlacementResult>

A promise which resolves when the operation is completed successfully - i.e. the user places an observer and/or target(s), leaving the analysis in a valid state. Otherwise, the promise is rejected.

Example
const abortController = new AbortController();
try {
await analysisView.place({
signal: abortController.signal,
// optional elevation info
elevationInfo: { 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 point
abortController.abort();

when

inherited Method
Signature
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
Type parameters
<TResult1 = this, TResult2 = never>
Inherited from: EsriPromiseMixin
Since
ArcGIS Maps SDK for JavaScript 4.6

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

ParameterTypeDescriptionRequired
onFulfilled

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 onFulfilled that 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 way
let 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
});