LineOfSightAnalysis

ESM: import LineOfSightAnalysis from "@arcgis/core/analysis/LineOfSightAnalysis.js";
CDN: const LineOfSightAnalysis = await $arcgis.import("@arcgis/core/analysis/LineOfSightAnalysis.js");
Class: @arcgis/core/analysis/LineOfSightAnalysis
Inheritance: LineOfSightAnalysisAnalysisAccessor
Since: ArcGIS Maps SDK for JavaScript 4.23

LineOfSightAnalysis computes the line of sight from a single observer position towards a set of targets. The results are visualized in a 3D SceneView.

To display the line of sight between two points, create a new instance of LineOfSightAnalysis, add it to SceneView.analyses, and set the observer and targets properties.

If the observer position or target position have z-values then these will be treated as absolute values, otherwise the points will be aligned to the ground.

Use the LineOfSightAnalysisView3D to retrieve analysis results.

// create line of sight analysis
const lineOfSightAnalysis = new LineOfSightAnalysis({
  observer: new LineOfSightAnalysisObserver({ position: new Point({ }) }),
  targets:[
    new LineOfSightAnalysisTarget({ position: new Point({ }) })
  ]
});

// add to the view
view.analyses.add(lineOfSightAnalysis);

// wait for the view to not be updating to ensure we get the latest results.
await reactiveUtils.whenOnce(() => !view.updating);

// retrieve the results from the analysis view.
const analysisView = await view.whenAnalysisView(lineOfSightAnalysis);
const results = analysisView.results;

The line of sight analysis can also be added to a LineOfSightLayer which can be persisted in a web scene:

// create line of sight layer containing the analysis
const lineOfSightLayer = new LineOfSightLayer({
  analysis: lineOfSightAnalysis
});

// add to the map
view.map.add(lineOfSightLayer);

To place the observer and targets interactively, use the LineOfSightAnalysisView3D.place() method.

const abortController = new AbortController();

try {
  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();

The analysis results are displayed as colored lines, where areas visible to the observer are shown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility. When the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either the target or the observer is not in the view.

Use the Line Of Sight component to display a user interface for the line of sight analysis.

Known Limitation

  • 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

LineOfSightAnalysis

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

Observer location.

LineOfSightAnalysis

The origin of the analysis.

Analysis

Target locations.

LineOfSightAnalysis

The type of analysis.

LineOfSightAnalysis

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.

LineOfSightAnalysis

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.

Observer location. This is the point from which line of sight analysis is performed.

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.

Autocasts from Object[]

Target locations. A list of points to look at from the observer.

type

Property
type Stringreadonly

The type of analysis. For line of sight analysis, this is always "line-of-sight".

For LineOfSightAnalysis the type is always "line-of-sight".

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 LineOfSightAnalysis since 4.23, valid added at 4.33.

Indicates whether the analysis is ready to be computed and interacted with in the view. It requires an observer with a position.

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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

LineOfSightAnalysisFeatureReference

Type Definition
LineOfSightAnalysisFeatureReference
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.