LineOfSightTarget

AMD: require(["esri/widgets/LineOfSight/LineOfSightTarget"], (LineOfSightTarget) => { /* code goes here */ });
ESM: import LineOfSightTarget from "@arcgis/core/widgets/LineOfSight/LineOfSightTarget";
Class: esri/widgets/LineOfSight/LineOfSightTarget
Inheritance: LineOfSightTarget Accessor
Since: ArcGIS Maps SDK for JavaScript 4.14

This class represents a target point for a LineOfSight analysis. The location represents the Point the observer is looking at, while visible indicates whether the line between the observer and the target intersects 3D graphics, integrated mesh or the ground. If it intersects 3D graphics, then the intersectedGraphic property will point to the first intersected graphic. The intersectedLocation corresponds to the first intersection with a 3D graphic, integrated mesh or the ground.

See also

Constructors

new LineOfSightTarget(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Graphic

The first Graphic intersected by the line of sight.

more details
LineOfSightTarget
Point

A Point representing the location where the line of sight first intersects the ground or 3D objects in the scene.

more details
LineOfSightTarget
Point

A Point representing the location of the target.

more details
LineOfSightTarget
Boolean

Whether the target is visible from the observer or not.

more details
LineOfSightTarget

Property Details

declaredClass Stringreadonly inherited

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

intersectedGraphic Graphicreadonly

The first Graphic intersected by the line of sight. If no graphic is intersected then this property is null.

intersectedLocation Pointreadonly

A Point representing the location where the line of sight first intersects the ground or 3D objects in the scene. If the target is visible this property is null.

location Pointautocast

A Point representing the location of the target. Once the location is set, a new line of sight analysis will synchronously calculate the intersection and the visibility.

visible Booleanreadonly

Whether the target is visible from the observer or not.

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.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.