ElevationProfileLineView

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

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
more detailsElevationProfileLineView
String

The name of the class.

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

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

more details
more detailsElevationProfileLineView
Point

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

more details
more detailsElevationProfileLine
String

Unique identifier for the profile line.

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

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

more details
more detailsElevationProfileLineView
Number

How far along the generation of this profile is.

more details
more detailsElevationProfileLine
ElevationProfileSample[]

List of samples that make up the elevation profile.

more details
more detailsElevationProfileLine
ElevationProfileStatistics

Statistics about the generated elevation profile, if available.

more details
more detailsElevationProfileLine
String

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

more details
more detailsElevationProfileLine
String

The line type.

more details
more detailsElevationProfileLineView
Boolean

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

more details
more detailsElevationProfileLine

Property Details

Autocasts from Object|Number[]|String

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

Default Value:#bf4cf5
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.

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

visible Boolean inherited

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

Default Value:true