ElevationProfileLineGround

AMD: require(["esri/widgets/ElevationProfile/ElevationProfileLineGround"], (ElevationProfileLineGround) => { /* code goes here */ });
ESM: import ElevationProfileLineGround from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLineGround.js";
Class: esri/widgets/ElevationProfile/ElevationProfileLineGround
Inheritance: ElevationProfileLineGround ElevationProfileLine Accessor
Since: ArcGIS Maps SDK 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
Color

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

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

ElevationProfileLineGround
Boolean

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

ElevationProfileLineGround
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 in the view.

Default Value:#ff7f00

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

hoveredPoint

Inherited
Property
hoveredPoint Pointreadonly
Inherited from ElevationProfileLine

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

id

Inherited
Property
id String
Inherited from ElevationProfileLine

Unique identifier for the profile line.

progress

Inherited
Property
progress Numberreadonly
Inherited from ElevationProfileLine

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

samples

Inherited
Property
samples ElevationProfileSample[]readonly
Inherited from ElevationProfileLine

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

Inherited
Property
statistics ElevationProfileStatisticsreadonly
Inherited from ElevationProfileLine

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

Inherited
Property
title String
Inherited from ElevationProfileLine

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

type

Property
type Stringreadonly

The line type.

For ElevationProfileLineGround the type is always "ground".

viewVisualizationEnabled

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

Inherited
Property
visible Boolean
Inherited from ElevationProfileLine

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.

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");

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