ESM: import Viewshed from "@arcgis/core/analysis/Viewshed.js";
CDN: const Viewshed = await $arcgis.import("@arcgis/core/analysis/Viewshed.js");
Class: @arcgis/core/analysis/Viewshed
Since: ArcGIS Maps SDK for JavaScript 4.30
Viewshed defines the geometry for a viewshed analysis. The viewshed is determined by a position, distance, orientation (defined by heading and tilt), and field of view angles.
const viewshed = new Viewshed({
observer: new Point({
spatialReference: {
latestWkid: 3857,
wkid: 102100
},
x: -9754426,
y: 5143111,
z: 330
}),
farDistance: 900,
heading: 64,
tilt: 84,
horizontalFieldOfView: 85,
verticalFieldOfView: 52
});
const viewshedAnalysis = new ViewshedAnalysis({
viewsheds: [viewshed],
});
view.analyses.add(viewshedAnalysis);
To create a view dome, set horizontalFieldOfView to 360, and verticalFieldOfView to 180.
Note that when placing viewsheds interactively, the viewshed is created with a 1.5 meter vertical offset from the scene. This behavior is subject to change in a future release.
new Viewshed(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Name Type Summary Class declaredClass StringThe name of the class.
Accessor farDistance NumberThe maximum distance from the observer in which to perform the viewshed analysis (in meters).
Viewshed feature ViewshedFeatureReference|null|undefinedReferences a feature from which the observer is internally offset, provided that its geometry faces are close enough to the observer.
Viewshed heading NumberThe compass heading of the observer's view direction (in degrees).
Viewshed horizontalFieldOfView NumberThe horizontal field of view (FOV) angle defines the width of the scope being analyzed (in degrees).
Viewshed observer Point|null|undefinedA Point specifying the position the viewshed is calculated from.
Viewshed tilt NumberThe tilt of the observer's view direction (in degrees).
Viewshed valid BooleanIndicates whether the viewshed is ready to be computed and interacted with in the view.
Viewshed verticalFieldOfView NumberThe vertical field of view (FOV) angle defines the height of the scope being analyzed (in degrees).
Viewshed Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
farDistance Number
The maximum distance from the observer in which to perform the viewshed analysis (in meters).
Since: ArcGIS Maps SDK for JavaScript 4.31 Viewshed since 4.30, feature added at 4.31.
References a feature from which the observer is internally offset, provided that its geometry faces are close enough to the observer. It is used to ensure that the analysis results remain independent of changes in the level of detail (LOD) of this feature's geometry.
When creating viewsheds interactively, this property is populated automatically.
Note that you can assign client side graphics which will be taken into account accordingly. However, information about client side graphics will not be persisted and results in an empty reference after de-serialization.
heading Number
The compass heading of the observer's view direction (in degrees). A heading of zero points the viewshed to north and it increases as the viewshed rotates clockwise.
horizontalFieldOfView Number
The horizontal field of view (FOV) angle defines the width of the scope being analyzed (in degrees). A value of 360 means the observer's horizontal FOV captures their entire surroundings. Values closer to 0 narrow the horizontal FOV in the direction of the heading.
A Point specifying the position the viewshed is calculated from.
The tilt of the observer's view direction (in degrees). A tilt of zero points the viewshed looking straight down and 90 degrees points it looking parallel to the surface.
valid Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 Viewshed since 4.30, valid added at 4.33.
Indicates whether the viewshed is ready to be computed and interacted with in the view. It requires the observer to be set and have a position, and the farDistance to be greater than 0.
verticalFieldOfView Number
The vertical field of view (FOV) angle defines the height of the scope being analyzed (in degrees). This value can vary from 0 to 180. Values closer to 0 narrow the vertical FOV in the direction of the tilt.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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.
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.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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"); ViewshedFeatureReference
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4