Profile line which samples elevation from the Ground of the Map currently set in the View.
Whenever layers are added or removed from the Ground or their visibility changes, the profile line will be updated.
- See also
const elevationProfile = new ElevationProfile({
view: view,
profiles: [{
type: "ground", // autocasts as new ElevationProfileLineGround(),
color: "red", // display this profile in red
title: "World elevation" // with a custom label
}]
});
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Color | Color of the line on the chart and in the view. more details | ElevationProfileLineGround | |
String | The name of the class. more details | Accessor | |
Point | Point being hovered in the chart, in the view's spatial reference. more details | ElevationProfileLine | |
String | Unique identifier for the profile line. more details | ElevationProfileLine | |
Number | How far along the generation of this profile is. more details | ElevationProfileLine | |
ElevationProfileSample[] | List of samples that make up the elevation profile. more details | ElevationProfileLine | |
ElevationProfileStatistics | Statistics about the generated elevation profile, if available. more details | ElevationProfileLine | |
String | Title of the line, to be displayed in the chart tooltip and in the chart legend. more details | ElevationProfileLine | |
String | The line type. more details | ElevationProfileLineGround | |
Boolean | Whether a line visualization representing elevationSamples should be added to the SceneView. more details | ElevationProfileLineGround | |
Boolean | Whether the line should be computed and shown in the chart. more details | ElevationProfileLine |
Property Details
-
Color of the line on the chart and in the view.
- Default Value:#ff7f00
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
Point being hovered in the chart, in the view's spatial reference.
-
Unique identifier for the profile line.
-
How far along the generation of this profile is. 0 means nothing was loaded and 1 means loading is complete.
-
-
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 about the generated elevation profile, if available. For slope computations profiles are sampled at a minimum sampling distance of 10m (32.8ft). Higher resolution profiles are downsampled to a 10m (32.8ft) sampling distance before the slope is calculated.
-
Title of the line, to be displayed in the chart tooltip and in the chart legend.
-
type Stringreadonly
-
The line type.
For ElevationProfileLineGround the type is always "ground".
-
viewVisualizationEnabled BooleanSince: ArcGIS Maps SDK for JavaScript 4.20
-
Whether a line visualization representing elevationSamples should be added to the SceneView. This property doesn't apply to MapView.
- Default Value:true
-
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. 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)inheritedSince: 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 } ); 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.
-
Since: ArcGIS Maps SDK for JavaScript 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");