ElevationProfileAnalysis

The ElevationProfileAnalysis class enables programmatic creation and management of elevation profiles in both, a SceneView and a MapView. An elevation profile visualizes elevation changes along a specified Polyline, which is provided via the geometry property.

This analysis supports multiple profile lines, each representing a different source or method for sampling elevation, such as ground, input geometry, custom elevation sources, or scene content. The configuration of these lines is managed through the profiles property.

To add an elevation profile analysis to a view:

const elevationProfileAnalysis = new ElevationProfileAnalysis({
  profiles: [
    // Profile line that samples the ground elevation
    {
      type: "ground",
      color: "rgb(150, 75, 0)",
    }
  ],
  geometry: new Polyline({ })
});

view.analyses.add(elevationProfileAnalysis);

The MapView.analyses and SceneView.analyses collections can contain multiple elevation profile analyses simultaneously.

Use the ElevationProfileAnalysisView2D or ElevationProfileAnalysisView3D to retrieve the analysis results. The combined statistics, as well as results for each computed profile line, can be then visualized in a custom chart using any charting library, embedded in a dashboard, exported as a CSV file, or used for further calculations.

// Get the analysis view
const analysisView = await view.whenAnalysisView(elevationProfileAnalysis);
// Retrieve the results, once they are ready
reactiveUtils.watch(
  () => analysisView.progress,
  (progress) => {
    if (progress === 1) {
      console.log("Results are computed", analysisView.results);
      console.log("Statistics are computed", analysisView.statistics);
    }
  }
);

To interactively place an elevation profile, use the ElevationProfileAnalysisView2D.place() or ElevationProfileAnalysisView3D.place() methods.

const abortController = new AbortController();

try {
  // Start placing a new profile line interactively
  await analysisView.place({ signal: abortController.signal });
} catch (error) {
  if (error.name === "AbortError") {
    console.log("Placement operation was cancelled.");
  }
}

// Cancel the operation at some later point
abortController.abort();

How distances are computed depends on the scene's or map's spatial reference:

• In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically, taking the curvature of the planet into consideration.
• In projected coordinate systems (PCS), apart from Web Mercator, the distances are computed in a Euclidean manner (in their respective PCS).

For a ready-to-use UI, use the Elevation Profile component, which allows users to interactively place an elevation profile and view the results in a chart.