ElevationProfileLineQuery

Class: esri/widgets/ElevationProfile/ElevationProfileLineQuery
Inheritance: ElevationProfileLineQuery ElevationProfileLine Accessor
Since: ArcGIS API for JavaScript 4.18
beta

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.

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 // use a custom elevation layer of source for the profile
  }]
});

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
Color

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

more details
more detailsElevationProfileLineQuery
String

The name of the class.

more details
more detailsAccessor
Point

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

more details
more detailsElevationProfileLine
String

Unique identifier for the profile line.

more details
more detailsElevationProfileLine
Number

How far along the generation of this profile is.

more details
more detailsElevationProfileLine
ElevationProfileSample[]

List of samples that make up the elevation profile.

more details
more detailsElevationProfileLine
ElevationQuerySource

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

more details
more detailsElevationProfileLineQuery
ElevationProfileStatistics

Statistics about the generated elevation profile, if available.

more details
more detailsElevationProfileLine
String

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

more details
more detailsElevationProfileLine
String

The line type.

more details
more detailsElevationProfileLineQuery
Boolean

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

more details
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.

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

Statistics about the generated elevation profile, if available.

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".

visible Boolean inherited

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

Default Value:true

Type Definitions

ElevationQuerySource Object

Interface which needs to be respected by an ElevationProfileLineQuery source. One example of a valid source is an ElevationLayer.

Property:
queryElevation Function

Function which receives an input geometry and some options and returns an elevation query result.