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

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

more detailsElevationProfileLineView
Stringmore details

The name of the class.

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

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

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

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

more detailsElevationProfileLineView
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 detailsElevationProfileLineView
Booleanmore details

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

more detailsElevationProfileLineView
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:#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

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