ElevationProfileLineQuery | API Reference | ArcGIS Maps SDK for JavaScript

Represents a profile line that samples elevation from a custom elevation source, such as an ElevationLayer, or from an elevation layer in ground.layers.

You can also provide a custom source object with a queryElevation method that matches the signature of queryElevation, allowing for flexible elevation sampling strategies.

See also

ElevationProfileAnalysis

Example

// Create an elevation profile analysis with a custom elevation layer as the source
const elevationLayer = new ElevationLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Elevation/MtBaldy_Elevation/ImageServer"
});

const analysis = new ElevationProfileAnalysis({
  profiles: [{
    type: "query",
    source: elevationLayer
  }]
});

Constructors

ElevationProfileLineQuery Constructor new ElevationProfileLineQuery(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

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
ElevationProfileLineChartOptions	Options for visualizing the profile line in a chart.	ElevationProfileLine
Color	Color of the line on the chart and in the view.	ElevationProfileLineQuery
String	The name of the class.	Accessor
Boolean	Indicates whether the line should be computed and displayed in the chart and view.	ElevationProfileLine
String	Unique identifier for the profile line.	ElevationProfileLine
Object	Elevation source used to sample elevation when generating the profile, for example an ElevationLayer.	ElevationProfileLineQuery
String\|null\|undefined	Title of the line, shown in the chart tooltip and legend.	ElevationProfileLine
String	The line type.	ElevationProfileLineQuery
ElevationProfileLineViewOptions	Options for visualizing the profile line in the view.	ElevationProfileLine

Property Details

chartOptions Inherited Property chartOptions ElevationProfileLineChartOptionsautocast Inherited from ElevationProfileLine

Options for visualizing the profile line in a chart.

color Property color Colorautocast

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.

enabled Inherited Property enabled Boolean Inherited from ElevationProfileLine

Indicates whether the line should be computed and displayed in the chart and view.

Default Value:true

id Inherited Property id String Inherited from ElevationProfileLine

Unique identifier for the profile line. This value is automatically generated unless specified.

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.

Examples

const elevLayer = new ElevationLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/.../Elevation/ImageServer"
});

// profile line with elevation layer source
const analysis1 = new ElevationProfileAnalysis({
  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 analysis2 = new ElevationProfileAnalysis({
  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
const sampler = await elevLayer.createElevationSampler(extent);

const analysis3 = new ElevationProfileAnalysis({
  profiles: [{
    type: "query",
    source: {
      queryElevation: async (geometry: Multipoint) => {
        return {
          geometry: await sampler.queryElevation(geometry),
          noDataValue: sampler.noDataValue
        };
      }
    }
  }]
});

title Inherited Property title String |null |undefined Inherited from ElevationProfileLine

Title of the line, shown in the chart tooltip and legend.

type Property type Stringreadonly

The line type.

For ElevationProfileLineQuery the type is always "query".

viewOptions Inherited Property viewOptions ElevationProfileLineViewOptionsautocast Inherited from ElevationProfileLine

Options for visualizing the profile line in the view.

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
this	Creates a deep clone of this object.	ElevationProfileLine
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

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.

clone Inherited Method clone(){this} Inherited from ElevationProfileLine

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns

Type	Description
this	A deep clone of the class instance that invoked this method.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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

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|null|undefined

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.