ElevationProfileLineView

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

Profile line which samples elevation directly from the SceneView.

All volumetric objects in a SceneView contribute to the resulting profile, including Ground, SceneLayer, IntegratedMeshLayer and FeatureLayers with volumetric 3D symbols (e.g. ObjectSymbol3DLayer, PathSymbol3DLayer). The input graphic itself is excluded when the profile is generated. When the Camera changes, the profile line will be updated to reflect what is currently visible in the view.

This profile line type is not supported in a MapView.

elevation-profile The purple building profile is the result of a profile line of type view.

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

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
ElevationProfileLineView
String

The name of the class.

more details
Accessor
Array<(IntersectItem|Collection<IntersectItem>|Array<IntersectItem>|Ground)>|Collection<IntersectItem>|IntersectItem

Items which are to be excluded when querying elevation from view.

more details
ElevationProfileLineView
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
Array<(IntersectItem|Collection<IntersectItem>|Array<IntersectItem>|Ground)>|Collection<IntersectItem>|IntersectItem

Items which are to be hit when querying elevation from view.

more details
ElevationProfileLineView
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
ElevationProfileLineView
Boolean

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

more details
ElevationProfileLineView
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:#cf4ccf
declaredClass Stringreadonly inherited

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

Items which are to be excluded when querying elevation from view.

hoveredPoint Pointreadonly inherited

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

Unique identifier for the profile line.

Items which are to be hit when querying elevation from view.

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 ElevationProfileLineView the type is always "view".

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

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.