ElevationProfileResult | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ElevationProfileResult→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.34

Represents the result for each profile line configured in the ElevationProfileAnalysis.profiles collection. This result is initialized by the analysis view and is dynamically updated as the elevation profile is generated.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ElevationProfileResultProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`available` readonly	`boolean`
`declaredClass` readonly inherited	`string`	Accessor
`profile` readonly	`ElevationProfileLineUnion`
`progress` readonly	`number`
`samples` readonly	`ElevationProfileSample[] \| null \| undefined`
`statistics` readonly	`ElevationProfileStatistics \| null \| undefined`

available

readonly Property

Type: boolean

Indicates whether the line is available. Unavailable lines are not sampled or displayed, and the corresponding samples and statistics will be empty.

Availability rules for each line type:

ground: Available if any ground layers are visible.
input: Always available.
query: Available if the source is visible and any layers in that source (e.g. ground elevation layers) are also visible.
scene: Always available in 3D.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

profile

readonly Property

Type: ElevationProfileLineUnion

The profile line whose elevation is represented by this result.

progress

readonly Property

Type: number

Represents the progress of the elevation profile generation, ranging from 0 to 1.

samples

readonly Property

Type: ElevationProfileSample[] | null | undefined

Contains the samples that make up the elevation profile. Each sample represents a point along the profile.

The distance and elevation values are given in the effective units specified in ElevationProfileAnalysisView2D.effectiveDisplayUnits or ElevationProfileAnalysisView3D.effectiveDisplayUnits.

statistics

readonly Property

Type: ElevationProfileStatistics | null | undefined

Provides statistics about the elevation profile, including minimum, maximum, and average elevation values, elevation gain and loss, and slope information.

The distance and elevation values are given in the effective units specified in ElevationProfileAnalysisView2D.effectiveDisplayUnits or ElevationProfileAnalysisView3D.effectiveDisplayUnits.

Methods

Method	Signature	Class
`clone` inherited	`clone(): this`	ClonableMixin

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.