arcgis-elevation-profile

Since

ArcGIS Maps SDK for JavaScript 5.0

The ElevationProfileAnalysis created or modified by the component.

When connecting the Elevation Profile component to the arcgis-map or arcgis-scene components, it automatically creates an empty analysis and adds it to the Map's arcgis-map.analyses collection or the Scene's arcgis-scene.analyses collection. You can then wait for the ElevationProfileAnalysisView2D or ElevationProfileAnalysisView3D to be created (depending on whether you are using a Map or Scene component) before accessing the analysis results.

// Get the Scene component and the Elevation Profile component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const elevationProfileElement = document.querySelector("arcgis-elevation-profile");
await elevationProfileElement.componentOnReady();

// Get the ElevationProfileAnalysis created by the Elevation Profile component.
const analysis = elevationProfileElement.analysis;

// Get the ElevationProfileAnalysisView3D and watch for results.
const analysisView = await viewElement.whenAnalysisView(analysis);
const handle = reactiveUtils.watch(
  () => analysisView?.results,
  () => {
    console.log("Analysis results:", analysisView.results);
  },
);

Whenever the component is destroyed, the analysis is automatically removed from the collection.

Alternatively, a programmatically created ElevationProfileAnalysis can be provided to the component. Then, the application itself needs to add it to and later remove it from the analyses collection of the Map or Scene component.

// Create the ElevationProfileAnalysis.
const analysis = new ElevationProfileAnalysis({
  profiles: [{ type: "ground" }, { type: "scene" }]
});

// Get the Scene component and the Elevation Profile component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const elevationProfileElement = document.querySelector("arcgis-elevation-profile");
await elevationProfileElement.componentOnReady();

// Add the analysis to the analyses collection of the Scene component.
viewElement.analyses.add(analysis);

// Connect the analysis to the elevation profile component.
elevationProfileElement.analysis = analysis;

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy() method when you are done to prevent memory leaks.

Since

ArcGIS Maps SDK for JavaScript 5.0

The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values in the chart, results and legend.

Since

ArcGIS Maps SDK for JavaScript 5.0

List of available units unit systems (imperial, metric) and specific units (e.g. feet, kilometers) for displaying the distance values. These are the options displayed in the distance unit dropdown in the settings popover.

Since

ArcGIS Maps SDK for JavaScript 5.0

Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the component, according to the selected elevation and distance units or unit systems.

Since

ArcGIS Maps SDK for JavaScript 5.0

Specifies how the geometry Z values are interpreted, for example to compute elevations for an input profile line. This property can only be used in a SceneView.

Read more

Since

ArcGIS Maps SDK for JavaScript 5.0

The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values in the chart, results and legend.

Since

ArcGIS Maps SDK for JavaScript 5.0

List of available units unit systems (imperial, metric) and specific units (e.g. feet, kilometers) for displaying the elevation values. These are the options displayed in the elevation unit dropdown in the settings popover.

Since

ArcGIS Maps SDK for JavaScript 5.0

The feature which is currently selected for display in the elevation profile. The feature is highlighted in the view and its geometry is used as the profile line. When the user starts drawing a new profile line, this feature is cleared.

Since

ArcGIS Maps SDK for JavaScript 5.0

Path along which elevation will be queried in order to generate an elevation profile. It should be a Polyline geometry. Read more

If true, the elevation profile chart will be hidden.

If true, the clear button will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the distance display unit dropdown will be hidden in the settings popover.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the elevation display unit dropdown will be hidden in the settings popover.

If true, the legend will be hidden.

If true, the button to select features in the view will be hidden.

If true, the button which opens the settings popover will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the button to start sketching a new profile line will be hidden.

If true, the uniform chart scaling toggle will be hidden in the settings popover.

Since

ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the component's visualization is hidden in the view.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the component will not highlight features selected in the view.

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Since

ArcGIS Maps SDK for JavaScript 5.0

Relative position along the current elevation profile line, in the range [0, 1]. The component updates this value as the user hovers the chart.

Read more

The component's default label.

Since

ArcGIS Maps SDK for JavaScript 5.0

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

The collection of profile lines to compute and display. Each profile line defines a different source for sampling elevation along the input geometry (such as ground, input geometry itself, custom elevation sources, or scene content), and includes settings for how the resulting line will appear in the component chart and in the view.

Read more

The progress, between 0 and 1 of generating all the configured elevation profiles.

Read more

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

The component's state. The values mean the following:

• disabled - component is being created
• ready - component 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

Whether the chart should use a uniform scale for the X and Y axes.

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-elevation-profile component will be associated with a map or scene component rather than using the view property.

Since

ArcGIS Maps SDK for JavaScript 5.0

Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.

Creates a promise that resolves once the component is fully loaded.

Permanently destroy the component.

Since

ArcGIS Maps SDK for JavaScript 5.0

Start an interactive operation to pick an existing polyline feature in the view to use as the input for the elevation profile. The operation ends when the user presses the Escape key. To programmatically cancel the operation, call the stop() method.

Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile will be generated. The operation completes when the user double-clicks, presses the Escape key or clicks the Done button in the UI. To programmatically cancel the operation, call the stop() method.

Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to programmatically cancel operations started by start() or select().