ElevationProfileLine

AMD: require(["esri/widgets/ElevationProfile/ElevationProfileLine"], (ElevationProfileLine) => { /* code goes here */ });
ESM: import ElevationProfileLine from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLine";
Class: esri/widgets/ElevationProfile/ElevationProfileLine
Inheritance: ElevationProfileLine Accessor
Since: ArcGIS API for JavaScript 4.18

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
Color

Color of the line on the chart and the hovered points in the view.

more details
ElevationProfileLine
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
ElevationProfileLine
Boolean

Whether a line visualization representing elevationSamples should be added to the SceneView.

more details
ElevationProfileLine
Boolean

Whether the line should be computed and shown in the chart.

more details
ElevationProfileLine

Property Details

Autocasts from Object|Number[]|String

Color of the line on the chart and the hovered points in the view.

Default Value:#000000
declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

hoveredPoint Pointreadonly

Point being hovered in the chart, in the view's spatial reference.

id String

Unique identifier for the profile line.

progress Numberreadonly

How far along the generation of this profile is. 0 means nothing was loaded and 1 means loading is complete.

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 ElevationProfileStatisticsreadonly

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 String

Title of the line, to be displayed in the chart tooltip and in the chart legend.

type Stringreadonly

The line type.

Possible Values:"ground"|"input"|"query"|"view"

viewVisualizationEnabled Boolean
Since: ArcGIS API 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
visible Boolean

Whether the line should be computed and shown in the chart.

Default Value:true

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.

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)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");

Type Definitions

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 Number

The y coordinate of the sample, in the spatial reference of the view.

z Number
optional

The z coordinate of the sample, in the spatial reference of the view.

distance Number

Distance from the beginning of the path, in the effective selected by the user.

elevation Number
optional

The elevation of the sample, in the effective units selected by the user.

ElevationProfileStatistics Object

Represents the statistics for the generated profile line.

Properties
maxDistance Number

The maximum distance or length of the path.

minElevation Number

The minimum elevation along the path.

maxElevation Number

The maximum elevation along the path.

avgElevation Number

The average elevation along the path.

elevationGain Number

The cumulative elevation gain along the path.

elevationLoss Number

The cumulative elevation loss along the path.

maxSlope Number

The maximum slope along the path. Slope is calculated by sampling over a distance of 10m (32.8ft) or more.

avgSlope Number

The average slope along the path. Slope is calculated by sampling over a distance of 10m (32.8ft) or more.

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