arcgis-volume-measurement

The VolumeMeasurementAnalysis created or modified by the component.

When connecting the Volume Measurement component to the arcgis-scene component, it automatically creates an empty analysis and adds it to the Scene's arcgis-scene.analyses collection. You can then wait for the VolumeMeasurementAnalysisView3D to be created before accessing the analysis results.

// Get the Scene component and the Volume Measurement component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const volumeMeasurementElement = document.querySelector("arcgis-volume-measurement");
await volumeMeasurementElement.componentOnReady();

// Get the VolumeMeasurementAnalysis created by the Volume Measurement component.
const analysis = volumeMeasurementElement.analysis;

// Get the VolumeMeasurementAnalysisView3D 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 VolumeMeasurementAnalysis 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 Scene component.

// Create the VolumeMeasurementAnalysis.
const volumeMeasurementAnalysis = new VolumeMeasurementAnalysis({
   geometry: new Polygon({
     spatialReference: { latestWkid: 3857, wkid: 102100 },
     rings: [
       [
         [-13624861.22274897, 4550346.5519295, 63.378210234455764],
         [-13624935.305160372, 4550273.144585712, 63.37829629518092],
         [-13624995.61798748, 4550334.030096778, 63.37819860037416],
         [-13624921.53589075, 4550407.42357004, 63.3783810287714],
         [-13624861.22274897, 4550346.5519295, 63.378210234455764]
       ]
     ]
   })
});
// Get the Scene component and the Volume Measurement component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const volumeMeasurementElement = document.querySelector("arcgis-volume-measurement");
await volumeMeasurementElement.componentOnReady();

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

// Connect the analysis to the measurement component:
volumeMeasurementElement.analysis = volumeMeasurementAnalysis;

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

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

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.

Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in elevationDisplayUnitOptions.

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, meters, millimeters, centimeters, decimeters, kilometers, inches, feet, yards, miles, nautical-miles, us-feet. Possible elevationDisplayUnit values can only be a subset of this list.

Unit used for inputting the cut and fill target elevation. Possible values are listed in elevationInputUnitOptions.

This controls which unit is used when entering an elevation value via the tool's UI (for example, using the shift manipulator tooltip input in "Cut & Fill Volume" mode).

List of available units that are shown in the elevation input unit dropdown.

By default, the following units are included: inches, feet, yards, miles, nautical-miles, us-feet, millimeters, centimeters, decimeters, meters, kilometers. The current elevationInputUnit value can only be a subset of this list.

Indicates the heading level to use for the headings in the component.

If true, the area display unit dropdown will be hidden.

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

If true, the elevation input unit dropdown will be hidden.

If true, the header will be hidden.

If true, the mode selection dropdown will be hidden.

If true, the perimeter display unit dropdown will be hidden.

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

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

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

If true, the volume display unit dropdown will be hidden.

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.

Specifies the analysis' desired measurement type.

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

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

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 - not ready yet
• ready - ready for measuring
• measuring - currently measuring
• measured - measuring has finished

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

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

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

Clears the current measurement.

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

Permanently destroy the component.

Starts a new measurement.