ElevationProfileError | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ElevationProfileError→Error

Since: ArcGIS Maps SDK for JavaScript 4.34

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

The following error names are defined:

"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

Constructor

Parameters

Parameter	Type	Description
name	`ElevationProfileErrorName`	The error name.
message	`string`	A message describing the details of the error.
details	`T`	Additional information that is specific to the error.

Properties

Property	Type	Class
`details` inherited	`T \| null \| undefined`	Error
`message` readonly inherited	`string`	Error
`name` readonly	`ElevationProfileErrorName`

details

inherited Property

Type: T | 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

readonlyinherited Property

Type: string

Inherited from: Error

Message describing the error.

Example

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

name

readonly Property

Type: ElevationProfileErrorName

The name of the elevation profile error.

Default value: "unknown"

Example

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

Type definitions

ElevationProfileErrorName

Type definition

The elevation profile error name.

Type: "too-complex" | "elevation-query-error" | "unknown"