ElevationProfile

require(["esri/widgets/ElevationProfile"], function(ElevationProfile) { /* code goes here */ });

Class: esri/widgets/ElevationProfile

Inheritance: ElevationProfile Widget Accessor

Since: ArcGIS API for JavaScript 4.18

beta

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

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

Once all profiles are refined to their maximum resolution, the corresponding 3D profile lines appear in the scene view (no lines in map view), and profile statistics display in the widget. Note that certain statistics fields display only when a single profile is active. 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 hiding 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.

Drawing a path to get a ground profile.

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

For information about gaining full control of widget styles, see the Styling topic.

See also:

Example:

const elevationProfile = new ElevationProfile({
  view: view
});
// adds the ElevationProfile to the top right corner of the view
view.ui.add(elevationProfile, "top-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

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	more details	Widget
String	The name of the class. more details	more details	Accessor
Number	When the spatial reference is projected (other than web mercator) and the path is shorter than this threshold, distances will be computed planimetrically. more details	more details	ElevationProfile
String	The widget's default CSS icon class. more details	more details	ElevationProfile
String	The unique ID assigned to the widget when the widget is created. more details	more details	Widget
Graphic	The input path along which elevation will be queried in order to generate an elevation profile. more details	more details	ElevationProfile
String	The widget's default label. more details	more details	ElevationProfile
Collection<(ElevationProfileLineGround\|ElevationProfileLineInput\|ElevationProfileLineQuery\|ElevationProfileLineView)>	Collection of elevation profile lines which are to be generated and displayed in the widget's chart. more details	more details	ElevationProfile
SystemOrLengthUnit	Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. more details	more details	ElevationProfile
SystemOrLengthUnit []	List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. more details	more details	ElevationProfile
SceneView\|MapView	A reference to the SceneView or the MapView. more details	more details	ElevationProfile
ElevationProfileViewModel	The view model for this widget. more details	more details	ElevationProfile
VisibleElements	This property provides the ability to display or hide the individual elements of the widget. more details	more details	ElevationProfile

Property Details

container String|HTMLElement inherited

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.

id String inherited

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.

input Graphicautocast

The input path 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.

profiles Collection<(ElevationProfileLineGround|ElevationProfileLineInput|ElevationProfileLineQuery|ElevationProfileLineView)>autocast

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 statistics. The order of the profiles within the collection determines the drawing order on the chart.

In a MapView ground is the only supported profile line type.

Example:

const elevationProfile = new ElevationProfile({
  view: view,
  profiles: [{
    type: "ground", //autocasts as new ElevationProfileLineGround()
  }, {
    type: "input",  //autocasts as new ElevationProfileLineInput()
  }, {
    type: "query",  //autocasts as new ElevationProfileLineQuery()
  }, {
    type: "view"    //autocasts as new ElevationProfileLineView()
  }]
});

unit SystemOrLengthUnit

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.

view SceneView|MapView

A reference to the SceneView or the MapView.

viewModel ElevationProfileViewModelautocast

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.

visibleElements VisibleElements

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

Example:

elevationProfile.visibleElements = {
   statistics: true,
   legend: true,
   sketchButton: true,
   selectButton: true
}

Method Overview

Show inherited methods Hide inherited methods

Return Type	Summary	Class
String	A utility method used for building the value for a widget's `class` property. more details	more details	Widget
	Destroys the widget instance. more details	more details	Widget
Boolean	Emits an event on the instance. more details	more details	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	more details	Widget
Object	Registers an event handler on the instance. more details	more details	Widget
	Widget teardown helper. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Object	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Renders widget to the DOM immediately. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget

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:

Guide - Widget development (rendering)

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.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String|String []

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:

Type Description

Object

Returns an event handler with a remove() method that can 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 WatchHandle|WatchHandle []

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.

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 statistics, legend, sketchButton, and selectButton. These are all set to true by default.

Properties:

statistics Boolean

optional

Default Value:true

When set to false, the statistics are not displayed.

legend Boolean

optional

Default Value:true

When set to false, chart legend 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.

	Site wide shortcuts
`?`	Bring up this help dialog
`esc`	Dismiss this help dialog
`gh`	Go to Home
`gg`	Go to Guide
`ga`	Go to API Reference
`gs`	Go to Sample Code
`gt`	Scroll to top of page
`spacebar`	Scroll page down
`shift spacebar`	Scroll page up
`gb`	Scroll to bottom of page

	API Reference
`/`	Focus search
`esc`	Remove search focus
`enter`	Focus first search result
`c`	Go to Constructors
`p`	Go to Properties
`m`	Go to Methods
`t`	Go to Type definitions
`e`	Go to Events

JavaScript API 4.18 API Reference

JavaScript API API Reference

ElevationProfile

ElevationProfile

Constructors

Property Overview

Property Details

Method Overview

Method Details

Type Definitions

JavaScript API 4.18 API Reference

JavaScript API API Reference

Constructors

Property Overview

Property Details

Method Overview

Method Details

Type Definitions

API Reference search results