ElevationProfileLine

Class: esri/widgets/ElevationProfile/ElevationProfileLine
Inheritance: ElevationProfileLine Accessor
Since: ArcGIS API for JavaScript 4.18
beta

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
more detailsElevationProfileLine
String

The name of the class.

more details
more detailsAccessor
Point

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

more details
more detailsElevationProfileLine
String

Unique identifier for the profile line.

more details
more detailsElevationProfileLine
Number

How far along the generation of this profile is.

more details
more detailsElevationProfileLine
ElevationProfileSample[]

List of samples that make up the elevation profile.

more details
more detailsElevationProfileLine
ElevationProfileStatistics

Statistics about the generated elevation profile, if available.

more details
more detailsElevationProfileLine
String

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

more details
more detailsElevationProfileLine
String

The line type.

more details
more detailsElevationProfileLine
Boolean

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

more details
more detailsElevationProfileLine

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"

visible Boolean

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

Default Value:true

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.