require(["esri/analysis/LineOfSightAnalysis"], (LineOfSightAnalysis) => { /* code goes here */ });
import LineOfSightAnalysis from "@arcgis/core/analysis/LineOfSightAnalysis.js";
esri/analysis/LineOfSightAnalysis
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 property.
Use the LineOfSightAnalysisView3D to retrieve analysis results.
// create line of sight analysis
const lineOfSightAnalysis = new LineOfSightAnalysis({
observer: new LineOfSightAnalysisObserver({ position: somePoint),
targets:[
new LineOfSightAnalysisTarget({position: someOtherPoint})
]
});
// add to scene view
view.analyses.add(lineOfSightAnalysis);
// wait for the view to load before checking the result
await reactiveUtils.whenOnce(() => !view.updating);
// retrieve measured results from analysis view
const analysisView = await view.whenAnalysisView(lineOfSightAnalysis);
const results = analysisView.results;
Use the LineOfSight widget in order to add interactivity and allow users to change the geometry of the analysis.
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.
Known Limitation
This analysis is only supported in a 3D SceneView.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
Observer location. | LineOfSightAnalysis | ||
Target locations. | LineOfSightAnalysis |
Property Details
-
observer
Propertyobserver LineOfSightAnalysisObserverautocast -
Observer location. This is the point from which line of sight analysis is performed.
-
targets
Propertytargets Collection<LineOfSightAnalysisTarget>autocast -
Target locations. A list of points to look at from the observer.
Method Overview
| 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. | LineOfSightAnalysis | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");