ElevationProfileLineQuery

AMD: require(["esri/widgets/ElevationProfile/ElevationProfileLineQuery"], (ElevationProfileLineQuery) => { /* code goes here */ });
ESM: import ElevationProfileLineQuery from "@arcgis/core/widgets/ElevationProfile/ElevationProfileLineQuery";
Class: esri/widgets/ElevationProfile/ElevationProfileLineQuery
Inheritance: ElevationProfileLineQuery ElevationProfileLine Accessor
Since: ArcGIS API for JavaScript 4.18

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 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 detailsElevationProfileLineQuery
Stringmore details

The name of the class.

more detailsAccessor
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
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
Objectmore details

Elevation source used to sample elevation when generating the profile, for example an ElevationLayer.

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

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

more detailsElevationProfileLineQuery
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:#db334a
declaredClass Stringreadonly inherited

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

hoveredPoint Pointreadonly inherited

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

Unique identifier for the profile line.

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.

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 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 ElevationProfileLineQuery the type is always "query".

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

Type Definitions

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:

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.

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