import ElevationProfileAnalysisView2D from "@arcgis/core/views/2d/analysis/ElevationProfileAnalysisView2D.js";const ElevationProfileAnalysisView2D = await $arcgis.import("@arcgis/core/views/2d/analysis/ElevationProfileAnalysisView2D.js");- Inheritance:
- ElevationProfileAnalysisView2D→
AnalysisView2D→ AnalysisView→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.34
Represents the analysis view of an ElevationProfileAnalysis after it has been added to MapView.analyses.
The ElevationProfileAnalysisView2D is responsible for rendering an ElevationProfileAnalysis using custom visualizations. The results property contains the computed elevation profile results.
The view for an analysis can be retrieved using MapView.whenAnalysisView() similar to how layer views are retrieved for layers using MapView.whenLayerView().
// Retrieve analysis view for analysisconst analysis = new ElevationProfileAnalysis();view.analyses.add(analysis); // Add to the viewconst analysisView = await view.whenAnalysisView(analysis);Properties
| Property | Type | Class |
|---|---|---|
analysis readonly | | |
declaredClass readonly inherited | ||
effectiveDisplayUnits readonly | | |
error readonly | | |
indicatorPoints readonly | | |
| | ||
| | ||
progress readonly | | |
results readonly | | |
statistics readonly | | |
type readonly | "elevation-profile-view-2d" | |
updating readonly | | |
| |
effectiveDisplayUnits
Units used for all the results and statistics of the elevation profile analysis.
If not specified by user with ElevationProfileAnalysis.displayUnits, the units are chosen automatically based on the magnitude of the results.
error
- Type
- ElevationProfileError | null | undefined
Error encountered while calculating the analysis result. The error has well defined names that can be used to provide specific error feedback to the user. See ElevationProfileError for the list of possible error names.
indicatorPoints
Points in the view that are computed from the indicatorRelativePosition
property (in the view's spatial reference).
There is one point for each profile line.
When a result of a profile line is not available or
no sample exists for the specified indicator
position, the point is undefined.
Whenever the indicatorRelativePosition property has a value, the points are calculated and, by default, rendered in the view. The points in the view can be hidden using the viewOptions.indicatorPointVisible setting on any of the profile lines.
indicatorRelativePosition
Relative position along a result's profile line, in [0, 1]. Set this (e.g., when hovering a chart) to compute locations along each configured profile line and expose them via indicatorPoints. The view shows points at these locations unless a line's viewOptions.indicatorPointVisible disables them.
progress
- Type
- number
Combined progress (0 to 1) of generating all configured profiles.
Example
reactiveUtils.watch( () => analysisView.progress, (progress) => { // Watch the progress and update the chart or UI when needed }); results
- Type
- ElevationProfileResult[]
Results of the elevation profile analysis. Result objects are created immediately but they are gradually updated as the analysis is computed.
Watch progress to see the state of the calculation.
statistics
- Type
- ElevationProfileStatistics | null | undefined
Combined statistics of all the computed profile lines.
Methods
| Method | Signature | Class |
|---|---|---|
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
pickFeature(options?: AbortOptions | null | undefined): Promise<ElevationProfilePickResult> | | |
place(options?: AbortOptions | null | undefined): Promise<ElevationProfilePlacementResult> | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); pickFeature
- Signature
-
pickFeature (options?: AbortOptions | null | undefined): Promise<ElevationProfilePickResult>
Starts an interactive operation to pick a line feature in the view to use as the input for the elevation profile analysis.
The operation will finish when the user presses the escape key. To stop the operation programmatically, pass an abort signal as an argument when calling the method.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional options. | |
- Returns
- Promise<ElevationProfilePickResult>
A promise which resolves when the operation is completed successfully or rejected if it is canceled.
Example
// Use AbortController to cancel the picking operation at some later point by calling abortController.abort()const abortController = new AbortController();
try { await analysisView.pickFeature({ signal: abortController.signal });} catch (error) { if (error.name === "AbortError") { console.log("Picking operation was cancelled."); }} place
- Signature
-
place (options?: AbortOptions | null | undefined): Promise<ElevationProfilePlacementResult>
Starts the interactive placement of a new input line for the elevation profile analysis.
If the analysis does not have a ElevationProfileAnalysis.geometry yet, the method allows drawing it interactively in the view. Otherwise, clicking in the view will remove the previous input line and start a new placement operation.
The placement operation will finish when the user presses the escape key. To stop the placing programmatically, pass an abort signal as an argument when calling the method.
Calling this method sets interactive to true.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional options. | |
- Returns
- Promise<ElevationProfilePlacementResult>
A promise which resolves when the operation is completed successfully or rejected if it is canceled.
Example
// Use AbortController to cancel the placement operation at some later point by calling abortController.abort()const abortController = new AbortController();
try { await analysisView.place({ signal: abortController.signal });} catch (error) { if (error.name === "AbortError") { console.log("Placement operation was cancelled."); }} when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});