require(["esri/widgets/ElevationProfile/ElevationProfileLineView"], (ElevationProfileLineView) => { /* code goes here */ });
import ElevationProfileLineView from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLineView.js";
esri/widgets/ElevationProfile/ElevationProfileLineView
Profile line which samples elevation directly from the SceneView.
All volumetric objects in a SceneView contribute to the resulting profile, including Ground, SceneLayer, IntegratedMeshLayer, IntegratedMesh3DTilesLayer, 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.
The purple building profile is the result of a profile line of type view.
- See also
const elevationProfile = new ElevationProfile({
view: view,
profiles: [{
type: "view"
}]
});
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Color of the line on the chart and in the view. | ElevationProfileLineView | ||
The name of the class. | Accessor | ||
Items which are to be excluded when querying elevation from view. | ElevationProfileLineView | ||
Point being hovered in the chart, in the view's spatial reference. | ElevationProfileLine | ||
Unique identifier for the profile line. | ElevationProfileLine | ||
Items which are to be hit when querying elevation from view. | ElevationProfileLineView | ||
How far along the generation of this profile is. | ElevationProfileLine | ||
List of samples that make up the elevation profile. | ElevationProfileLine | ||
Statistics about the generated elevation profile, if available. | ElevationProfileLine | ||
Title of the line, to be displayed in the chart tooltip and in the chart legend. | ElevationProfileLine | ||
The line type. | ElevationProfileLineView | ||
Whether a line visualization representing elevationSamples should be added to the SceneView. | ElevationProfileLineView | ||
Whether the line should be computed and shown in the chart. | ElevationProfileLine |
Property Details
-
Color of the line on the chart and in the view.
- Default Value:#cf4ccf
-
exclude
exclude Array<(IntersectItem|Collection<IntersectItem>|Array<IntersectItem>|Ground)> |Collection<IntersectItem> |IntersectItem
-
Items which are to be excluded when querying elevation from view.
-
hoveredPoint
InheritedPropertyhoveredPoint Pointreadonly
Inherited from ElevationProfileLine -
Point being hovered in the chart, in the view's spatial reference.
-
id
InheritedPropertyid String
Inherited from ElevationProfileLine -
Unique identifier for the profile line.
-
include
include Array<(IntersectItem|Collection<IntersectItem>|Array<IntersectItem>|Ground)> |Collection<IntersectItem> |IntersectItem
-
Items which are to be hit when querying elevation from view.
-
progress
InheritedPropertyprogress 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
InheritedPropertysamples 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
InheritedPropertystatistics 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
InheritedPropertytitle String
Inherited from ElevationProfileLine -
Title of the line, to be displayed in the chart tooltip and in the chart legend.
-
type
type Stringreadonly
-
The line type.
For ElevationProfileLineView the type is always "view".
-
viewVisualizationEnabled
viewVisualizationEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.20ElevationProfileLineView 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
InheritedPropertyvisible Boolean
Inherited from ElevationProfileLine -
Whether the line should be computed and shown in the chart.
- Default Value:true
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");