require(["esri/widgets/ElevationProfile/ElevationProfileViewModel"], (ElevationProfileViewModel) => { /* code goes here */ });
import ElevationProfileViewModel from "@arcgis/core/widgets/ElevationProfile/ElevationProfileViewModel.js";
esri/widgets/ElevationProfile/ElevationProfileViewModel
Provides the logic for the ElevationProfile widget.
- See also
Constructors
-
new ElevationProfileViewModel(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
EffectiveUnits | Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the widget, according to the selected unit or unit system. more details | ElevationProfileViewModel | |
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 | ElevationProfileViewModel | |
Boolean | Whether the graphic used as input is highlighted. more details | ElevationProfileViewModel | |
Number | The position, in the range [0, 1], being hovered in the graph. more details | ElevationProfileViewModel | |
Graphic | The input path along which elevation will be queried in order to generate an elevation profile. more details | ElevationProfileViewModel | |
Collection<(ElevationProfileLineGround|ElevationProfileLineInput|ElevationProfileLineQuery|ElevationProfileLineView)> | Collection of elevation profile lines which are to be generated and displayed in the widget's chart. more details | ElevationProfileViewModel | |
Number | The progress, between 0 and 1 of generating all the configured elevation profiles. more details | ElevationProfileViewModel | |
String | The current state of the view model that can be used for rendering the UI of the widget. more details | ElevationProfileViewModel | |
Boolean | Whether the chart should use a uniform scale for the X and Y axes. more details | ElevationProfileViewModel | |
SystemOrLengthUnit | Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. more details | ElevationProfileViewModel | |
SystemOrLengthUnit[] | List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. more details | ElevationProfileViewModel | |
SceneView|MapView | A reference to the View. more details | ElevationProfileViewModel |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
effectiveUnits EffectiveUnitsreadonly
-
Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the widget, according to the selected unit or unit system.
-
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
-
highlightEnabled BooleanSince: ArcGIS Maps SDK for JavaScript 4.20
-
Whether the graphic used as input is highlighted. The highlight color and opacity can be changed in highlightOptions.
- Default Value:true
-
hoveredChartPosition Number
-
The position, in the range [0, 1], being hovered in the graph. We'll use this to determine which samples are being hovered and mark their position in the view.
-
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.
-
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 ElevationProfileLineView is not supported.
-
progress Numberreadonly
-
The progress, between 0 and 1 of generating all the configured elevation profiles.
-
state Stringreadonly
-
The current state of the view model that can be used for rendering the UI of the widget.
Value Description disabled widget is being created ready widget is ready. No path configured and no interactive operation ongoing. creating user is creating a new input path. created input path is configured but no interactive operation is ongoing. selecting user is selecting an existing input path. selected user selected an existing input path. Possible Values:"disabled"|"ready"|"creating"|"created"|"selecting"|"selected"
- Default Value:disabled
-
uniformChartScaling BooleanSince: ArcGIS Maps SDK for JavaScript 4.20
-
Whether the chart should use a uniform scale for the X and Y axes. When a uniform scale is applied, the X axis will display the same distance units per pixel as the elevation units per pixel displayed in the Y axis.
-
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.
-
A reference to the View.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Stops a creation/selection operation and restores the previously configured input path. more details | ElevationProfileViewModel | ||
Clears the existing profile and stops any interaction. more details | ElevationProfileViewModel | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
If mode is "sketch" (the default), switches to the "creating" state in which the user can draw a new line. more details | ElevationProfileViewModel | ||
Stops a creation/selection operation. more details | ElevationProfileViewModel |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
cancel()
-
Stops a creation/selection operation and restores the previously configured input path.
-
clear()
-
Clears the existing profile and stops any interaction.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
start(options)
-
If mode is "sketch" (the default), switches to the "creating" state in which the user can draw a new line. If the mode is "select", switches to the "selecting" state and lets the user click on the view to select an existing line.
If any line is present, when the first point is drawn or an existing line is selected, the previous input is discarded.
Parametersoptions ObjectoptionalStart options.
Specificationmode StringoptionalDefault Value: "sketch"The mode that the widget will start with. In "sketch" mode the user can draw a new line and in "select" mode the user can click on the view to select an existing line.
Possible Values:"sketch"|"select"
-
stop()
-
Stops a creation/selection operation. If the current operation is a "sketch" and the input has at least two committed points (not being dragged), the input is kept. Otherwise the input is set to null.
Type Definitions
-
EffectiveUnits
-
The units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the widget, according to the selected unit or unit system.
- Properties
-
distance LengthUnit
Units used for displaying distance or length values.
elevation LengthUnitUnits used for displaying elevation values.