arcgis-distance-measurement-2d

Since

ArcGIS Maps SDK for JavaScript 5.0

The DistanceMeasurementAnalysis created or modified by the component.

When connecting the Distance Measurement 2D component to the arcgis-map component, it automatically creates an empty analysis and adds it to the Map's arcgis-map.analyses collection. You can then wait for the DistanceMeasurementAnalysisView2D to be created before accessing the analysis results.

// Get the Map component and the Distance Measurement 2D component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-map");
await viewElement.viewOnReady();
const distanceMeasurement2dElement = document.querySelector("arcgis-distance-measurement-2d");
await distanceMeasurement2dElement.componentOnReady();

// Get the DistanceMeasurementAnalysis created by the Distance Measurement 2D component.
const analysis = distanceMeasurement2dElement.analysis;

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

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

Alternatively, a programmatically created DistanceMeasurementAnalysis 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 component.

// Create the DistanceMeasurementAnalysis.
const distanceMeasurementAnalysis = new DistanceMeasurementAnalysis({
  geometry: new Polyline({
    paths: [
      [
        [-118.25, 34.05], // Los Angeles
        [-77.02, 38.90], // Washington, D.C.
      ]
    ],
  }),
  unit: "miles", // Display length in miles.
});

// Get the Map component and the Distance Measurement 2D component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-map");
await viewElement.viewOnReady();
const distanceMeasurement2dElement = document.querySelector("arcgis-distance-measurement-2d");
await distanceMeasurement2dElement.componentOnReady();

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

// Connect the analysis to the measurement component:
distanceMeasurement2dElement.analysis = distanceMeasurementAnalysis;

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

If true, the button that starts a new measurement will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the unit selection dropdown will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the component's visualization is hidden 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

The component's default label.

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 SnappingOptions for measuring.

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

• disabled - not ready yet
• ready - ready for measuring
• measuring - currently measuring
• measured - measuring has finished

Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in unitOptions.

List of available units and unit systems (imperial, metric) that are shown in the component's dropdown. By default, the following units are included: metric, imperial, inches, feet, us-feet, yards, miles, nautical-miles, meters, kilometers. Possible unit values can only be a subset of this list.

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-distance-measurement-2d component will be associated with a map or scene component rather than using the view property.

Clears the current measurement.

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

Permanently destroy the component.

Starts a new measurement.