VolumeMeasurementResult | API Reference | ArcGIS Maps SDK for JavaScript

Result obtained from a VolumeMeasurementAnalysisView3D.

If the result is unavailable, the VolumeMeasurementAnalysisView3D.error property provides the details on the cause.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Volume\|null\|undefined	Volume that needs to be removed to reach the target surface defined by the polygon.	VolumeMeasurementResult
String	The name of the class.	Accessor
Volume\|null\|undefined	Volume that needs to be added to reach the target surface defined by the polygon.	VolumeMeasurementResult
Volume\|null\|undefined	Difference between the cut volume and fill volume.	VolumeMeasurementResult
Volume\|null\|undefined	Sum of the cut volume and fill volume.	VolumeMeasurementResult

Property Details

cutVolume Property cutVolume Volume |null |undefined

Volume that needs to be removed to reach the target surface defined by the polygon.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

fillVolume Property fillVolume Volume |null |undefined

Volume that needs to be added to reach the target surface defined by the polygon.

netVolume Property netVolume Volume |null |undefined

Difference between the cut volume and fill volume. A positive value indicates a surplus volume that needs to be removed.

totalVolume Property totalVolume Volume |null |undefined

Sum of the cut volume and fill volume.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");