require(["esri/widgets/ElevationProfile/ElevationProfileLine"], (ElevationProfileLine) => { /* code goes here */ });
import ElevationProfileLine from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLine.js";
esri/widgets/ElevationProfile/ElevationProfileLine
Common interface for all the elevation profile lines.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Color of the line on the chart and the hovered points in the view. | ElevationProfileLine | ||
The name of the class. | Accessor | ||
Point being hovered in the chart, in the view's spatial reference. | ElevationProfileLine | ||
Unique identifier for the profile line. | ElevationProfileLine | ||
How far along the generation of this profile is. | ElevationProfileLine | ||
List of samples that make up the elevation profile. | ElevationProfileLine | ||
Statistics about the generated elevation profile, if available. | ElevationProfileLine | ||
Title of the line, to be displayed in the chart tooltip and in the chart legend. | ElevationProfileLine | ||
The line type. | ElevationProfileLine | ||
Whether a line visualization representing elevationSamples should be added to the SceneView. | ElevationProfileLine | ||
Whether the line should be computed and shown in the chart. | ElevationProfileLine |
Property Details
-
Color of the line on the chart and the hovered points in the view.
- Default Value:"#000000"
-
hoveredPoint
hoveredPoint Pointreadonly
-
Point being hovered in the chart, in the view's spatial reference.
-
id
id String
-
Unique identifier for the profile line.
-
progress
progress Numberreadonly
-
How far along the generation of this profile is. 0 means nothing was loaded and 1 means loading is complete.
-
samples
samples ElevationProfileSample[]readonly
-
List of samples that make up the elevation profile. It can be passed to a graphing library in order to display the profile in 2D.
-
statistics
statistics ElevationProfileStatisticsreadonly
-
Statistics about the generated elevation profile, if available.
For slope computations, profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to a 10-meter (32.8-foot) sampling distance before calculating the slope.
-
title
title String
-
Title of the line, to be displayed in the chart tooltip and in the chart legend.
-
type
type Stringreadonly
-
The line type.
Possible Values:"ground" |"input" |"query" |"view"
-
viewVisualizationEnabled
viewVisualizationEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.20ElevationProfileLine since 4.18, viewVisualizationEnabled added at 4.20. -
Whether a line visualization representing elevationSamples should be added to the SceneView. This property doesn't apply to MapView.
- Default Value:true
-
visible
visible Boolean
-
Whether the line should be computed and shown in the chart.
- Default Value:true
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
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.
-
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 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"); }
-
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");
Type Definitions
-
ElevationProfileSample
ElevationProfileSample Object
-
Represents an elevation sample in the profile.
- Properties
-
x Number
The x coordinate of the sample, in the spatial reference of the view.
y NumberThe y coordinate of the sample, in the spatial reference of the view.
z NumberThe z coordinate of the sample, in the spatial reference of the view.
distance NumberHorizontal (2D) distance from the beginning of the path, in the effective unit selected by the user. In geographic coordinate systems (GCS) and in WebMercator, the distance is the geodesic distance. In projected coordinate systems (PCS), apart from WebMercator, the distance is computed in a Euclidean manner (in the respective PCS).
elevation NumberThe elevation of the sample, in the effective units selected by the user.
-
ElevationProfileStatistics
ElevationProfileStatistics Object
-
Represents the statistics for the generated profile line.
- Properties
-
maxDistance Number
The maximum horizontal (2D) distance of the path. In geographic coordinate systems (GCS) and in WebMercator, the distance is the geodesic distance. In projected coordinate systems (PCS), apart from WebMercator, the distance is computed in a Euclidean manner (in the respective PCS).
minElevation NumberThe minimum elevation along the path.
maxElevation NumberThe maximum elevation along the path.
avgElevation NumberThe average elevation along the path.
elevationGain NumberThe cumulative elevation gain along the path.
elevationLoss NumberThe cumulative elevation loss along the path.
maxSlope NumberThe maximum slope along the path. Profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to that minimum sampling distance before calculating the slope.
avgSlope NumberThe average slope along the path. Profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to that minimum sampling distance before calculating the slope.