ElevationProfileLine | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Common interface for all the elevation profile lines.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Color	Color of the line on the chart and the hovered points in the view.	ElevationProfileLine
String	The name of the class.	Accessor
Point	Point being hovered in the chart, in the view's spatial reference.	ElevationProfileLine
String	Unique identifier for the profile line.	ElevationProfileLine
Number	How far along the generation of this profile is.	ElevationProfileLine
ElevationProfileSample []	List of samples that make up the elevation profile.	ElevationProfileLine
ElevationProfileStatistics	Statistics about the generated elevation profile, if available.	ElevationProfileLine
String	Title of the line, to be displayed in the chart tooltip and in the chart legend.	ElevationProfileLine
String	The line type.	ElevationProfileLine
Boolean	Whether a line visualization representing elevationSamples should be added to the SceneView.	ElevationProfileLine
Boolean	Whether the line should be computed and shown in the chart.	ElevationProfileLine

Property Details

color Property color Colorautocast Autocasts from Object|Number []|String

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

Default Value:"#000000"

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

hoveredPoint Property hoveredPoint Pointreadonly

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

id Property id String

Unique identifier for the profile line.

progress Property progress Numberreadonly

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

samples Property 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 Property 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 Property title String

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

type Property type Stringreadonly

The line type.

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

viewVisualizationEnabled Property viewVisualizationEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.20 ElevationProfileLine 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 Property visible Boolean

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

Default Value:true

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Type Definition 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

Horizontal (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 Number

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

ElevationProfileStatistics Type Definition 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 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. 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 Number

The 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.