The LineOfSightAnalysisTarget represents a target of a LineOfSightAnalysis.
Use the position property to specify the position of the target.
- See also:
Constructors
-
new LineOfSightAnalysisTarget(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
Object | more details Specifies how the target is placed on the vertical axis (z). | more details | LineOfSightAnalysisTarget | |
Graphic | more details Specifies a feature which shall be excluded from intersection testing. | more details | LineOfSightAnalysisTarget | |
Point | more details A Point representing the position of the target. | more details | LineOfSightAnalysisTarget |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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.
Mode Description on-the-ground Target is aligned to the Ground. If the scene contains an IntegratedMeshLayer, then features are aligned to the IntegratedMeshLayer. If features have z-values, then the z-values are ignored in this mode. Features with 2D symbols are draped on the Ground or IntegratedMeshLayer. This is the default mode for layers without z-values containing Polyline, Polygon features or Point features rendered with ObjectSymbol3DLayer. absolute-height Target is placed at an absolute elevation (z-value) above sea level. This z-value is determined by the geometry's z-value (if present). If featureExpressionInfo
is defined, the result of the expression is used instead of the geometry’s z-value. This mode doesn't take the elevation of the Ground or any other layers into account. This is the default value when target position hasZ istrue
.relative-to-ground Target is placed at an elevation relative to the Ground or IntegratedMeshLayer. The elevation is determined by summing up the elevation of the Ground or IntegratedMeshLayer and the geometry's z-value (if present). If featureExpressionInfo
is defined, the result of the expression is used instead of the targets z-value. If the target doesn't have a z-value,relative-to-ground
is the default value for Point geometries rendered with IconSymbol3DLayers.relative-to-scene Target is aligned to extruded polygons, 3D Object SceneLayers or BuildingSceneLayers, depending on which one has higher elevation. If the feature is not directly above a building or any other feature, it is aligned to the elevation of the Ground or the IntegratedMeshLayer. If present, the targets z-value is added to the elevation. If featureExpressionInfo
is defined, the result of the expression is used instead of the geometry’s z-value.Possible Values:"on-the-ground"|"relative-to-ground"|"absolute-height"|"relative-to-scene"
offset NumberAn elevation offset, which is added to the vertical position of the target. If
unit
is not defined, the offset is inmeters
. Whenmode = "on-the-ground"
, this property has no effect.
-
feature Graphic
-
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 acccordingly. However, information about client side graphic will not be persisted and results in an empty reference after de-serialization.
-
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
this | more details Creates a deep clone of this object. | more details | LineOfSightAnalysisTarget | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor |
Method Details
-
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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.