ElevationProfile

AMD: require(["esri/widgets/ElevationProfile"], (ElevationProfile) => { /* code goes here */ });
ESM: import ElevationProfile from "@arcgis/core/widgets/ElevationProfile";
Class: esri/widgets/ElevationProfile
Inheritance: ElevationProfile Widget Accessor
Since: ArcGIS API for JavaScript 4.18

The ElevationProfile widget is used to generate and display an elevation profile from an input line graphic. The input graphic can be set interactively by drawing a single or multi-segment line, or by selecting a line feature in the view. Alternatively the widget allows to set an input graphic programmatically on creation, or at runtime, by setting the input property.

elevation-profile ElevationProfile widget used in a city scene, displaying ground and building profiles. See Sample - ElevationProfile widget

The widget can visualize multiple profile lines, depending on the environment (2D versus 3D) and elevation source data:

  • ElevationProfileLineGround can be used in both MapView and SceneView. In this case, the elevation is sampled directly from Map.ground. Whether your map is displayed in 2D or 3D, the ground property needs to be set on the map.

  • ElevationProfileLineInput samples elevation data from the geometry of the input graphic. It is typically used with input line data with z values. If the input line data doesn't have z values, a profile line is also computed if the line is displayed with a non-draped elevation mode. An elevation offset can also be applied. Currently in 2D z values are not fetched from feature based layers, so in a MapView this profile line can only be used with client-side graphics with z values.

  • ElevationProfileLineQuery samples elevation data from the elevation source set in the source property. The elevation source can be an ElevationLayer or any object with a method called queryElevation, with the same signature as queryElevation.

  • ElevationProfileLineView is available only in a SceneView and it displays the elevation sampled directly from the view along the input graphic. All volumetric objects in a SceneView contribute to the resulting profile.

You can choose to display one or several profile lines in the chart, by setting them in the profiles property.

Once all profiles are refined to their maximum resolution, the corresponding 3D profile lines appear in the SceneView (currently no lines are displayed in a MapView), and profile statistics display in the legend for each profile line. Hovering on the chart shows an overlayed tooltip with elevation values of all profiles, and displays colored dot markers in the 3D view on the matching positions.

Checkboxes in the legend allow to hide individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit. Click-and-drag on the chart zooms in to a specific part of the profile chart. When zoomed in, click on the minus button to reset zoom.

elevation-profile-draw Drawing a path to get a ground profile.

elevation-profile-zline Profile generated from a line feature with z-values shows a paraglide track above ground.

Known Limitations

For information about gaining full control of widget styles, see the Styling topic.
See also:
Examples:
const elevationProfile = new ElevationProfile({
  view: view
});
// adds the ElevationProfile to the top right corner of the view
view.ui.add(elevationProfile, "top-right");
// elevation profile with all the line profiles
const elevationProfile = new ElevationProfile({
  view: view,
  profiles: [{
    // displays elevation values from Map.ground
    type: "ground", //autocasts as new ElevationProfileLineGround()
    color: "#61d4a4",
    title: "Ground elevation"
  }, {
    // displays elevation values from the input line graphic
    type: "input", //autocasts as new ElevationProfileLineInput()
    color: "#f57e42",
    title: "Line elevation"
  }, {
    // displays elevation values from a SceneView
    type: "view", //autocasts as new ElevationProfileLineView()
    color: "#8f61d4",
    title: "View elevation"
    // by default ground and all layers are used to compute elevation, but
    // you can define which elements should be included/excluded from the computation
    exclude: [map.ground]
  }, {
    // displays elevation values from a custom source
    type: "query",
    source: new ElevationLayer({
      url: "https://elevation3d.arcgis.com/arcgis/rest/../Terrain3D/ImageServer"
    }),
    color: "#d46189",
    title: "Custom elevation"
  }]
});
view.ui.add(elevationProfile, "bottom-right");

Constructors

new ElevationProfile(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String|HTMLElementmore details

The ID or node representing the DOM element containing the widget.

more detailsWidget
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

When the spatial reference is projected (other than web mercator) and the path is shorter than this threshold, distances will be computed planimetrically.

more detailsElevationProfile
Stringmore details

The widget's default CSS icon class.

more detailsElevationProfile
Stringmore details

The unique ID assigned to the widget when the widget is created.

more detailsWidget
Graphicmore details

The input line graphic along which elevation will be queried in order to generate an elevation profile.

more detailsElevationProfile
Stringmore details

The widget's default label.

more detailsElevationProfile
Collection<(ElevationProfileLineGround|ElevationProfileLineInput|ElevationProfileLineQuery|ElevationProfileLineView)>more details

Collection of elevation profile lines which are to be generated and displayed in the widget's chart.

more detailsElevationProfile
SystemOrLengthUnitmore details

Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.

more detailsElevationProfile
SystemOrLengthUnit[]more details

List of available units and unit systems (imperial, metric) for displaying the elevation and distance values.

more detailsElevationProfile
SceneView|MapViewmore details

A reference to the SceneView or the MapView.

more detailsElevationProfile
ElevationProfileViewModelmore details

The view model for this widget.

more detailsElevationProfile
Booleanmore details

Indicates whether the widget is visible.

more detailsWidget
VisibleElementsmore details

This property provides the ability to display or hide the individual elements of the widget.

more detailsElevationProfile

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
declaredClass Stringreadonly inherited

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

geodesicDistanceThreshold Number

When the spatial reference is projected (other than web mercator) and the path is shorter than this threshold, distances will be computed planimetrically. Otherwise distances will be computed geodetically.

Default Value:100000
iconClass String

The widget's default CSS icon class.

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

The input line graphic along which elevation will be queried in order to generate an elevation profile.

Typically not set when creating the widget. In this case the widget starts empty, and waits for the user to either draw a new profile or generate a profile from selecting a line feature. The result of this action populates input. input can be set when constructing the widget, or set or changed at runtime. The input graphic must contain a geometry of type Polyline, symbol and attributes of the input graphic are ignored.

Default Value:null
label String

The widget's default label.

Collection of elevation profile lines which are to be generated and displayed in the widget's chart. See the different profile line types for details on usage and behavior.

Once an elevation profile is generated, each line will contain the raw data used to generate the chart and profile statistics. The order of the profiles within the collection determines the drawing order on the chart.

In a MapView ElevationProfileLineView is not supported.

Example:
const elevationProfile = new ElevationProfile({
  view: view,
  profiles: [{
    // displays elevation values from Map.ground
    type: "ground", //autocasts as new ElevationProfileLineGround()
  }, {
    // displays elevation values from the input line graphic
    type: "input", //autocasts as new ElevationProfileLineInput()
  }, {
    // displays elevation values from an elevation source
    type: "query", //autocasts as new ElevationProfileLineQuery()
    source: elevationLayer
  }, {
    // displays elevation values from a SceneView
    type: "view" //autocasts as new ElevationProfileLineView()
  }]
});

Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.

unitOptions SystemOrLengthUnit[]

List of available units and unit systems (imperial, metric) for displaying the elevation and distance values.

A reference to the SceneView or the MapView.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the ElevationProfileViewModel class to access all properties and methods on the widget.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true
Example:
// Hides the widget in the view
widget.visible = false;
visibleElements VisibleElements

This property provides the ability to display or hide the individual elements of the widget.

Example:
elevationProfile.visibleElements = {
   legend: true,
   chart: true,
   clearButton: true,
   settingsButton: true,
   sketchButton: true,
   selectButton: true
   uniformChartScalingToggle: true
}

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Stringmore details

A utility method used for building the value for a widget's class property.

more detailsWidget
more details

Destroys the widget instance.

more detailsWidget
Booleanmore details

Emits an event on the instance.

more detailsWidget
Booleanmore details

Indicates whether there is an event listener on the instance that matches the provided event name.

more detailsWidget
Booleanmore details

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more detailsWidget
Booleanmore details

isRejected() may be used to verify if creating an instance of the class is rejected.

more detailsWidget
Booleanmore details

isResolved() may be used to verify if creating an instance of the class is resolved.

more detailsWidget
Objectmore details

Registers an event handler on the instance.

more detailsWidget
more details

Widget teardown helper.

more detailsWidget
more details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
Objectmore details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
more details

Renders widget to the DOM immediately.

more detailsWidget
more details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
Promisemore details

when() may be leveraged once an instance of the class is created.

more detailsWidget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:
classNames String|String[]|Object
repeatable

The class names.

Returns:
Type Description
String The computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
Type Description
Boolean true if a listener was notified
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
Type Description
Boolean Returns true if the class supports the input event.
isFulfilled(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

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:
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of supported events.

Parameters:

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:
Type Description
Object 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);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
Type Description
Object The rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.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
});

Type Definitions

VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off. The visual elements in this widget are the legend, chart, settingsButton, sketchButton, and selectButton. These are all set to true by default.

Properties:
legend Boolean
optional
Default Value:true

When set to false, the legend (which includes statistics) is not displayed.

chart Boolean
optional
Default Value:true

When set to false, the chart is not displayed.

clearButton Boolean
optional
Default Value:true

When set to false the button used to clear the current elevation profile is not displayed.

settingsButton Boolean
optional
Default Value:true

When set to false, the button used to open the settings popup is not displayed.

sketchButton Boolean
optional
Default Value:true

When set to false, the button used to start drawing/sketchinng is not displayed.

selectButton Boolean
optional
Default Value:true

When set to false, the button used to select a path is not displayed.

unitSelector Boolean
optional
Default Value:true

When set to false, the dropdown used to select the units is not displayed.

uniformChartScalingToggle Boolean
optional
Default Value:true

When set to false, the element used to toggle uniform chart scaling on or off is not displayed.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.