Common interface for all the elevation profile lines.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
Color | Color of the line on the chart and the hovered points in the view. more details | more details | ElevationProfileLine | |
String | The name of the class. more details | more details | Accessor | |
Point | Point being hovered in the chart, in the view's spatial reference. more details | more details | ElevationProfileLine | |
String | Unique identifier for the profile line. more details | more details | ElevationProfileLine | |
Number | How far along the generation of this profile is. more details | more details | ElevationProfileLine | |
ElevationProfileSample[] | List of samples that make up the elevation profile. more details | more details | ElevationProfileLine | |
ElevationProfileStatistics | Statistics about the generated elevation profile, if available. more details | more details | ElevationProfileLine | |
String | Title of the line, to be displayed in the chart tooltip and in the chart legend. more details | more details | ElevationProfileLine | |
String | The line type. more details | more details | ElevationProfileLine | |
Boolean | Whether the line should be computed and shown in the chart. more details | more details | ElevationProfileLine |
Property Details
-
Color of the line on the chart and the hovered points in the view.
- Default Value:#000000
-
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.
-
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 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 NumberDistance from the beginning of the path, in the effective selected by the user.
elevation NumberThe 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 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.