ElevationProfileLineInput | API Reference | ArcGIS Maps SDK for JavaScript

Represents a profile line that samples the geometry of the analysis directly. This is typically used for lines that have z values.

If the elevation info is configured to be "on-the-ground", the elevation is sampled from the Ground, provided the scene has ground layers.

Note: In 2D, this profile line can only be used when the analysis geometry has z values and hasZ===true and no elevation info is set.

See also

ElevationProfileAnalysis

Example

const analysis = new ElevationProfileAnalysis({
  geometry: new Polyline({ }), // The input line with z values
  profiles: [
    { type: "input", color: "orange" },
  ]
});

Constructors

ElevationProfileLineInput Constructor new ElevationProfileLineInput(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
ElevationProfileLineChartOptions	Options for visualizing the profile line in a chart.	ElevationProfileLine
Color	Color of the line on the chart and in the view.	ElevationProfileLineInput
String	The name of the class.	Accessor
Boolean	Indicates whether the line should be computed and displayed in the chart and view.	ElevationProfileLine
String	Unique identifier for the profile line.	ElevationProfileLine
String\|null\|undefined	Title of the line, shown in the chart tooltip and legend.	ElevationProfileLine
String	The line type.	ElevationProfileLineInput
ElevationProfileLineViewOptions	Options for visualizing the profile line in the view.	ElevationProfileLine

Property Details

chartOptions Inherited Property chartOptions ElevationProfileLineChartOptionsautocast Inherited from ElevationProfileLine

Options for visualizing the profile line in a chart.

color Property color Colorautocast

Color of the line on the chart and in the view.

Default Value:"#00c8c8"

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

enabled Inherited Property enabled Boolean Inherited from ElevationProfileLine

Indicates whether the line should be computed and displayed in the chart and view.

Default Value:true

id Inherited Property id String Inherited from ElevationProfileLine

Unique identifier for the profile line. This value is automatically generated unless specified.

title Inherited Property title String |null |undefined Inherited from ElevationProfileLine

Title of the line, shown in the chart tooltip and legend.

type Property type Stringreadonly

The line type.

For ElevationProfileLineInput the type is always "input".

viewOptions Inherited Property viewOptions ElevationProfileLineViewOptionsautocast Inherited from ElevationProfileLine

Options for visualizing the profile line in the view.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
this	Creates a deep clone of this object.	ElevationProfileLine
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Inherited Method clone(){this} Inherited from ElevationProfileLine

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

Type	Description
this	A deep clone of the class instance that invoked this method.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");