ElevationProfileError | API Reference | ArcGIS Maps SDK for JavaScript

ElevationProfileError

ESM: import ElevationProfileError from "@arcgis/core/views/analysis/ElevationProfile/ElevationProfileError.js";

CDN:

const ElevationProfileError = await $arcgis.import("@arcgis/core/views/analysis/ElevationProfile/ElevationProfileError.js");

Class: @arcgis/core/views/analysis/ElevationProfile/ElevationProfileError

Inheritance: ElevationProfileError→Error

Since: ArcGIS Maps SDK for JavaScript 4.34

beta

ElevationProfileError is an error class for reporting errors in an ElevationProfileAnalysisView2D or ElevationProfileAnalysisView3D.

The following error names are defined:

"invalid-geometry": The input geometry is invalid (for example, the path has less than two points).
"too-complex": The input geometry has too many points.
"elevation-query-error": An error occurred while querying the elevation data.
"unknown": An unknown error occurred.

See also

Constructors

ElevationProfileError Constructor new ElevationProfileError(name, message, details)

Parameters

name ElevationProfileErrorName

The error name.

message String

A message describing the details of the error.

details Object

optional

The details object provides additional details specific to the error.

Property Overview

Show inherited properties

Hide inherited properties

Type	Summary	Class
Object\|null\|undefined	The details object provides additional details specific to the error, giving more information about why the error was raised.	Error
String	A message describing the details of the error.	Error
ElevationProfileErrorName	The name of the elevation profile error.	ElevationProfileError

Property Details

details Inherited Property details Object |null |undefined Inherited from Error

The details object provides additional details specific to the error, giving more information about why the error was raised. For example, the details object for esriRequest includes additional information to help the developer diagnose issues with a problematic request.

Example

someAsyncFunction.then(callback)
  .catch(function(error){
    console.log("Error details: ", error.details);
});

message Inherited Property message String Inherited from Error

A message describing the details of the error.

Example

someAsyncFunction.then(callback)
  .catch(function(error){
    console.log("Error message: ", error.message);
});

name Property name ElevationProfileErrorName

The name of the elevation profile error.

Type Definitions

ElevationProfileErrorName Type Definition ElevationProfileErrorName String

The elevation profile error name.

Possible Values:"too-complex" |"invalid-geometry" |"elevation-query-error" |"unknown"