types | References | ArcGIS Maps SDK for JavaScript

Types

import type { ElevationProfileSample, ElevationProfileStatistics, ElevationProfilePlacementResult, ElevationProfilePickResult, ElevationProfileEffectiveDisplayUnits } from "@arcgis/core/views/analysis/ElevationProfile/types.js";

Since: ArcGIS Maps SDK for JavaScript 5.0

Types common to the ElevationProfileAnalysisView2D and ElevationProfileAnalysisView3D.

Type definitions

ElevationProfileSample

Type definition

Represents a single sampled point along the generated elevation profile.

x

readonly Property

Type: number

The x coordinate of the sample, in the spatial reference of the view.

y

readonly Property

Type: number

The y coordinate of the sample, in the spatial reference of the view.

z

readonly Property

Type: number | null | undefined

The z coordinate of the sample, in the spatial reference of the view.

distance

readonly Property

Type: number

Horizontal (2D) distance from the beginning of the path, expressed in the effective units selected for the analysis. In geographic coordinate systems (GCS) and WebMercator, the value is the geodesic distance. In projected coordinate systems (PCS) other than WebMercator, the value is calculated using Euclidean distance in the PCS.

elevation

readonly Property

Type: number | null | undefined

The elevation of the sample, in the effective units selected by the user.

ElevationProfileStatistics

Type definition

Combined statistics of all the computed elevation profile lines.

maxDistance

readonly Property

Type: number | null | undefined

The maximum horizontal (2D) distance of the path. In geographic coordinate systems (GCS) and in WebMercator, the distance is the geodesic distance. In projected coordinate systems (PCS), apart from WebMercator, the distance is computed in a Euclidean manner (in the respective PCS).

minElevation

readonly Property

Type: number | null | undefined

The minimum elevation along the path.

maxElevation

readonly Property

Type: number | null | undefined

The maximum elevation along the path.

avgElevation

readonly Property

Type: number | null | undefined

The average elevation along the path.

elevationGain

readonly Property

Type: number | null | undefined

The cumulative elevation gain along the path. See https://en.wikipedia.org/wiki/Cumulative_elevation_gain

elevationLoss

readonly Property

Type: number | null | undefined

The cumulative elevation loss along the path. See https://en.wikipedia.org/wiki/Cumulative_elevation_gain

maxPositiveSlope

readonly Property

Type: number | null | undefined

The maximum positive slope along the path. Profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to that minimum sampling distance before calculating the slope.

maxNegativeSlope

readonly Property

Type: number | null | undefined

The maximum negative slope along the path. Profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to that minimum sampling distance before calculating the slope.

avgPositiveSlope

readonly Property

Type: number | null | undefined

The average positive slope along the path. Profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to that minimum sampling distance before calculating the slope.

avgNegativeSlope

readonly Property

Type: number | null | undefined

The average negative slope along the path. Profiles are sampled at a minimum distance of 10 meters (32.8 feet). Higher resolution profiles are downsampled to that minimum sampling distance before calculating the slope.

ElevationProfilePlacementResult

Type definition

Result of interactively placing an elevation profile line on the view.

ElevationProfilePickResult

Type definition

Result of picking a feature from the view to perform an elevation profile analysis.

feature

Property

Type: Graphic

The picked feature.

ElevationProfileEffectiveDisplayUnits

Type definition

Effective units for the elevation profile analysis, determined from the magnitudes of all computed values and the display preferences selected by the user.

distance

readonly Property

Type: LengthUnit

The effective distance unit used for the results and statistics of the elevation profile analysis.

elevation

readonly Property

Type: LengthUnit

The effective elevation unit used for the results and statistics of the elevation profile analysis.