▾
import VolumeMeasurementDisplayUnits from "@arcgis/core/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits.js";const VolumeMeasurementDisplayUnits = await $arcgis.import("@arcgis/core/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits.js");- Inheritance
- VolumeMeasurementDisplayUnits→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.34
Units used for displaying values in the UI for the VolumeMeasurementAnalysis. If units are not specified here, they are read from ViewOptions.displayUnits, when configured.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| readonly inherited | ||
| | ||
| | ||
| |
area
- Type
- SystemOrAreaUnit | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Unit system (imperial, metric) or specific unit used for displaying area results.
elevation
- Type
- SystemOrLengthUnit | null | undefined
Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation.
length
- Type
- SystemOrLengthUnit | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Unit system (imperial, metric) or specific unit used for displaying length results (for example perimeter).
volume
- Type
- SystemOrVolumeUnit | null | undefined
Unit system (imperial, metric) or specific unit used for displaying volume results.
Methods
| Method | Signature | Class |
|---|---|---|
| inherited static | fromJSON(json: any): any | |
| inherited | clone(): this | |
| inherited | toJSON(): any |
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
clone
- Signature
-
clone (): this
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
- Returns
- this
A deep clone of the class instance that invoked this method.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.