ElevationProfileLineQuery | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

Example

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

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Color	Color of the line on the chart and in the view.	ElevationProfileLineQuery
String	The name of the class.	Accessor
Point	Point being hovered in the chart, in the view's spatial reference.	ElevationProfileLine
String	Unique identifier for the profile line.	ElevationProfileLine
Number	How far along the generation of this profile is.	ElevationProfileLine
ElevationProfileSample []	List of samples that make up the elevation profile.	ElevationProfileLine
Object	Elevation source used to sample elevation when generating the profile, for example an ElevationLayer.	ElevationProfileLineQuery
ElevationProfileStatistics	Statistics about the generated elevation profile, if available.	ElevationProfileLine
String	Title of the line, to be displayed in the chart tooltip and in the chart legend.	ElevationProfileLine
String	The line type.	ElevationProfileLineQuery
Boolean	Whether a line visualization representing elevationSamples should be added to the SceneView.	ElevationProfileLineQuery
Boolean	Whether the line should be computed and shown in the chart.	ElevationProfileLine

Property Details

color Property color Colorautocast Autocasts from Object|Number []|String

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

Default Value:"#db334a"

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

hoveredPoint Inherited Property hoveredPoint Pointreadonly Inherited from ElevationProfileLine

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

id Inherited Property id String Inherited from ElevationProfileLine

Unique identifier for the profile line.

progress Inherited Property progress 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 Inherited Property samples 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 Property 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.

Example

const 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 Inherited Property statistics 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 Inherited Property title String Inherited from ElevationProfileLine

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

type Property type Stringreadonly

The line type.

For ElevationProfileLineQuery the type is always "query".

viewVisualizationEnabled Property viewVisualizationEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.20 ElevationProfileLineQuery 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 Inherited Property visible Boolean Inherited from ElevationProfileLine

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

Default Value:true

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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");

Type Definitions

queryElevation Type Definition 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.

Parameters

Specification

geometry Point|Multipoint|Polyline

The geometry to use for sampling elevation data.

options Object

optional

Additional query options. See the table below.

Specification

demResolution Number|String

optional

Default Value: auto

Controls 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 Boolean

optional

Default Value: false

Indicates whether to return additional sample information for each coordinate.

noDataValue Number

optional

Default Value: 0

The value to use when there is no data available.

signal AbortSignal

optional

An AbortSignal to abort the request. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns

Type	Description
Promise<ElevationQueryResult>	Resolves to an object with the sampled geometry, resolution information, and no data value.