LineOfSightAnalysisTarget

AMD: require(["esri/analysis/LineOfSightAnalysisTarget"], (LineOfSightAnalysisTarget) => { /* code goes here */ });
ESM: import LineOfSightAnalysisTarget from "@arcgis/core/analysis/LineOfSightAnalysisTarget.js";
Class: esri/analysis/LineOfSightAnalysisTarget
Inheritance: LineOfSightAnalysisTarget Accessor
Since: ArcGIS Maps SDK for JavaScript 4.23

The LineOfSightAnalysisTarget represents a target of a LineOfSightAnalysis.

Use the position property to specify the position of the target.

See also

Constructors

LineOfSightAnalysisTarget

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

The name of the class.

Accessor

Specifies how the target is placed on the vertical axis (z).

LineOfSightAnalysisTarget

Specifies a feature which shall be excluded from intersection testing.

LineOfSightAnalysisTarget

A Point representing the position of the target.

LineOfSightAnalysisTarget

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.

elevationInfo

Property
elevationInfo Object

Specifies how the target is placed on the vertical axis (z). See the ElevationInfo sample for an example of how this property may be used.

Properties
mode String

Defines how the target is placed with respect to the terrain surface or 3D objects in the scene. See the table below for a list of possible values.

elevation-info

Mode Description
on-the-ground Target is aligned to the Ground. If the scene contains an IntegratedMeshLayer or IntegratedMesh3DTilesLayer, then the target is aligned to the IntegratedMeshLayer or IntegratedMesh3DTilesLayer. If that target has a z-value, then the z-value is ignored in this mode. This is the default value when hasZ on position is false.
absolute-height Target is placed at an absolute elevation (z-value) above sea level. This z-value is determined by the target's z-value (if present). This mode doesn't take the elevation of the Ground or any other layers into account. This is the default value when hasZ on position is true.
relative-to-ground Target is placed at an elevation relative to the Ground or IntegratedMeshLayer or IntegratedMesh3DTilesLayer. The elevation is determined by summing up the elevation of the Ground or IntegratedMeshLayer or IntegratedMesh3DTilesLayer and the geometry's z-value (if present).
relative-to-scene Target is aligned to extruded polygons, meshes, 3D Object SceneLayers or BuildingSceneLayers, depending on which one has higher elevation. If the target is not directly above a building or any other feature, it is aligned to the elevation of the Ground or the IntegratedMeshLayer or IntegratedMesh3DTilesLayer. If present, the target's z-value is added to the elevation.

Possible Values:"on-the-ground"|"relative-to-ground"|"absolute-height"|"relative-to-scene"

offset Number|null
optional

An elevation offset, which is added to the vertical position of the target. If unit is not defined, the offset is in meters. When mode = "on-the-ground", this property has no effect.

feature

Property
feature FeatureReference

Specifies a feature which shall be excluded from intersection testing. This is used when placing line of sight positions on scene geometry. Due to level of detail, the scene geometry may be subject to changes which would cause unstable analysis results. By specifying a feature which is to be excluded from intersection testing, this problem can be circumvented.

Note that you can assign client side graphics which will be taken into account accordingly. However, information about client side graphic will not be persisted and results in an empty reference after de-serialization.

position

Property
position Pointautocast

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

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.

LineOfSightAnalysisTarget

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

Method
clone(){this}

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");

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