ElevationProfileLineInput

AMD: require(["esri/widgets/ElevationProfile/ElevationProfileLineInput"], (ElevationProfileLineInput) => { /* code goes here */ });
ESM: import ElevationProfileLineInput from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLineInput";
Class: esri/widgets/ElevationProfile/ElevationProfileLineInput
Inheritance: ElevationProfileLineInput ElevationProfileLine Accessor
Since: ArcGIS API for JavaScript 4.18

Profile line which samples elevation from the geometry of the input Graphic itself, typically used on input lines with z values. If the input graphic is draped (elevation mode is "on-the-ground"), the elevation is sampled from the Ground, in case the scene has ground layers.

In 2D z values are not fetched from feature based layers. Therefore, a profile is generated for ElevationProfileLineInput only when the input feature is a client-side graphic with z values in a MapView.

elevation-profile-zline Profile generated from a line feature with z-values. The orange profile is created with a profile line of type input.

See also
Example
const elevationProfile = new ElevationProfile({
  view: view,
  profiles: [{
    type: "input",
    color: "orange"
  }, {
    type: "ground",
    color: "lime"
  }]
});

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.

more details
ElevationProfileLineInput
String

The name of the class.

more details
Accessor
Point

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

more details
ElevationProfileLine
String

Unique identifier for the profile line.

more details
ElevationProfileLine
Number

How far along the generation of this profile is.

more details
ElevationProfileLine
ElevationProfileSample[]

List of samples that make up the elevation profile.

more details
ElevationProfileLine
ElevationProfileStatistics

Statistics about the generated elevation profile, if available.

more details
ElevationProfileLine
String

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

more details
ElevationProfileLine
String

The line type.

more details
ElevationProfileLineInput
Boolean

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

more details
ElevationProfileLineInput
Boolean

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

more details
ElevationProfileLine

Property Details

Autocasts from Object|Number[]|String

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

Default Value:#00c8c8
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 ElevationProfileLineInput the type is always "input".

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:false
visible Boolean inherited

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.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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.