ElevationProfileLineGround

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

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.

elevation-profile-ground

See also:
Example:
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

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
Colormore details

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

more detailsElevationProfileLineGround
Stringmore details

The name of the class.

more detailsAccessor
Pointmore details

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

more detailsElevationProfileLine
Stringmore details

Unique identifier for the profile line.

more detailsElevationProfileLine
Numbermore details

How far along the generation of this profile is.

more detailsElevationProfileLine
ElevationProfileSample[]more details

List of samples that make up the elevation profile.

more detailsElevationProfileLine
ElevationProfileStatisticsmore details

Statistics about the generated elevation profile, if available.

more detailsElevationProfileLine
Stringmore details

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

more detailsElevationProfileLine
Stringmore details

The line type.

more detailsElevationProfileLineGround
Booleanmore details

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

more detailsElevationProfileLineGround
Booleanmore details

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

more detailsElevationProfileLine

Property Details

Autocasts from Object|Number[]|String

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

Default Value:#ff7f00
declaredClass Stringreadonly inherited

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

hoveredPoint Pointreadonly inherited

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

Unique identifier for the profile line.

progress Numberreadonly inherited

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 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 inherited

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

Default Value:true

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