VolumeMeasurementAnalysis

VolumeMeasurementAnalysis calculates and visualizes the volume of ground surfaces within a defined polygonal area, offering multiple measure types and displaying results in a 3D SceneView.

The measure type is set with the measureType property, and can be further customized using optional, type-specific options.

To display a volume measurement of a ground surface bounded by a given polygon:

• Create a new instance of VolumeMeasurementAnalysis.
• Set the measureType property.
• Set the geometry property to the given polygon instance.
• If using the "cut-fill" measureType, optionally set custom properties with VolumeMeasurementCutFillOptions.
• Add the VolumeMeasurementAnalysis instance to SceneView.analyses.

Use the VolumeMeasurementAnalysisView3D to retrieve the analysis result.

// create analysis
const volumeMeasurementAnalysis = new VolumeMeasurementAnalysis({
  measureType: "stockpile", // if not set it defaults to "cut-fill"
  geometry: new Polygon({ }),
});

// add to scene view
view.analyses.add(volumeMeasurementAnalysis);

// retrieve the result from the analysis view once available
const analysisView = await view.whenAnalysisView(volumeMeasurementAnalysis);
await reactiveUtils.whenOnce(() => analysisView.result);

const result = analysisView.result;

To draw a volume measurement polygon interactively, use the VolumeMeasurementAnalysisView3D.place() method.

// cancel the placement operation at some later point
// by calling abortController.abort()
const abortController = new AbortController();

try {
  await analysisView.place({ signal: abortController.signal });
} catch (error) {
  if (error.name === "AbortError") {
    console.log("Placement operation was cancelled.");
  }
}

The analysis depends on the scene's spatial reference, and the length of the measured perimeter:

• In Projected Coordinate Systems (PCS) apart from Web Mercator, used in local viewing mode:

  • There is no limit to the measurement's perimeter. This is the recommended setup for using the analysis as the accuracy is not compromised.

• In Web Mercator PCS used in local viewing mode:

  • If the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.

• In Geographic Coordinate Systems (GCS) and Web Mercator in global viewing mode:

  • If the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.

In certain situations (including information in Known Limitations below), the analysis result cannot be computed. Refer to the VolumeMeasurementAnalysisView3D.error property for more information.