require(["esri/widgets/ElevationProfile/ElevationProfileLineQuery"], (ElevationProfileLineQuery) => { /* code goes here */ });
import ElevationProfileLineQuery from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLineQuery.js";
esri/widgets/ElevationProfile/ElevationProfileLineQuery
Profile line which samples elevation from a custom elevation source, for example by creating a new ElevationLayer, or by using an elevation layer from ground.layers.
Additionally, you can create your own source object with a method called queryElevation
, with the same signature as
queryElevation.
- See also
const elevLayer = new ElevationLayer({
url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Elevation/MtBaldy_Elevation/ImageServer"
});
const elevationProfile = new ElevationProfile({
view: view,
profiles: [{
type: "query", // autocasts as new ElevationProfileLineQuery(),
source: elevLayer
}]
});
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Color of the line on the chart and in the view. | ElevationProfileLineQuery | ||
The name of the class. | Accessor | ||
Point being hovered in the chart, in the view's spatial reference. | ElevationProfileLine | ||
Unique identifier for the profile line. | ElevationProfileLine | ||
How far along the generation of this profile is. | ElevationProfileLine | ||
List of samples that make up the elevation profile. | ElevationProfileLine | ||
Elevation source used to sample elevation when generating the profile, for example an ElevationLayer. | ElevationProfileLineQuery | ||
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. | ElevationProfileLineQuery | ||
Whether a line visualization representing elevationSamples should be added to the SceneView. | ElevationProfileLineQuery | ||
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:"#db334a"
-
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.
-
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.
-
source
source Object
-
Elevation source used to sample elevation when generating the profile, for example an ElevationLayer.
- Property
-
queryElevation queryElevation
Function used to query elevation values for a geometry (Point, Multipoint or Polyline). It returns a promise that resolves with an ElevationQueryResult.
Exampleconst elevLayer = new ElevationLayer({ url: "https://sampleserver6.arcgisonline.com/arcgis/rest/.../Elevation/ImageServer" }); // profile line with elevation layer source const elevationProfile = new ElevationProfile({ view, profiles: [{ type: "query", // autocasts as new ElevationProfileLineQuery(), source: elevLayer }] }); // profile line with a source coming from an elevation // layer with a specific sampling resolution const elevationProfile = new ElevationProfile({ view, profiles: [{ type: "query", source: { queryElevation(geometry, options) { return elevLayer.queryElevation(geometry, { ...options, demResolution: 20 }) } } }] }); // profile line with a source that queries data // on an elevation sampler view.when(async() => { const sampler = await elevLayer.createElevationSampler(extent); const querySource = { queryElevation: async (geometry: Multipoint) => { return { geometry: await sampler.queryElevation(geometry), noDataValue: sampler.noDataValue }; } }; const elevationProfile = new ElevationProfile({ view, profiles: [{ type: "query", source: querySource }] }); });
-
statistics
InheritedPropertystatistics ElevationProfileStatisticsreadonly
Inherited from ElevationProfileLine -
Statistics about the generated elevation profile, if available.
For slope computations, profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to a 10-meter (32.8-foot) sampling distance before calculating the slope.
-
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 ElevationProfileLineQuery the type is always "query".
-
viewVisualizationEnabled
viewVisualizationEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.20ElevationProfileLineQuery 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");
Type Definitions
-
queryElevation
queryElevation(geometry, options){Promise<ElevationQueryResult>}
-
Function used to query elevation values for a geometry (Point, Multipoint or Polyline). It returns a promise that resolves with an ElevationQueryResult.
ParametersSpecificationgeometry Point|Multipoint|PolylineThe geometry to use for sampling elevation data.
options ObjectoptionalAdditional query options. See the table below.
Specificationoptional Default Value: autoControls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to
auto
). See the table below for more details on the different settings.demResolution Description auto
Automatically chooses an appropriate resolution for each coordinate of the input geometry. The current implementation will try to use the finest available resolution given that the total required number of tile requests does not exceed a certain maximum amount (currently 20). Note that this may result in values being sampled from different resolutions. finest-contiguous
Sample elevation from the finest available resolution (cell size) across the entire geometry. {number}
Sample elevation from the resolution closest to the specified resolution (in meters). returnSampleInfo BooleanoptionalDefault Value: falseIndicates whether to return additional sample information for each coordinate.
noDataValue NumberoptionalDefault Value: 0The value to use when there is no data available.
signal AbortSignaloptionalAn AbortSignal to abort the request. If canceled, the promise will be rejected with an error named
AbortError
. See also AbortController.ReturnsType Description Promise<ElevationQueryResult> Resolves to an object with the sampled geometry, resolution information, and no data value.