AreaMeasurement3DViewModel

require(["esri/widgets/AreaMeasurement3D/AreaMeasurement3DViewModel"], function(AreaMeasurement3DViewModel) { /* code goes here */ });
Class: esri/widgets/AreaMeasurement3D/AreaMeasurement3DViewModel
Inheritance: AreaMeasurement3DViewModel Accessor
Since: ArcGIS API for JavaScript 4.7

Provides the logic for the AreaMeasurement3D widget.

See also:

Constructors

new AreaMeasurement3DViewModel(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
more detailsAccessor
Object

The current measurement of the area.

more details
more detailsAreaMeasurement3DViewModel
String

The view model's state.

more details
more detailsAreaMeasurement3DViewModel
SystemOrAreaUnit

Unit system (imperial, metric) or specific unit used for displaying the area values.

more details
more detailsAreaMeasurement3DViewModel
SystemOrAreaUnit[]

List of available units and unit systems (imperial, metric) for displaying the area values.

more details
more detailsAreaMeasurement3DViewModel
SceneView

The view from which the widget will operate.

more details
more detailsAreaMeasurement3DViewModel

Property Details

declaredClass Stringreadonly inherited

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

measurement Objectreadonly

The current measurement of the area.

Properties:
measurementMode String

Describes the mode in which the measurement was taken. In euclidean mode, the area and perimeter length are computed from a flat polygon with straight segments on the perimeter in the ECEF coordinate system. In geodesic mode, the area and perimeter length are computed from a geodesic polygon on the WGS84 ellipsoid.

Possible Values:"euclidean"|"geodesic"

The area of the polygon.

perimeterLength MeasurementValue

The perimeter length of the polygon.

state Stringreadonly

The view model's state.

Value Description
disabled not ready yet
ready ready for measuring
measuring currently measuring
measured measuring has finished

Possible Values:"disabled"|"ready"|"measuring"|"measured"

Default Value:disabled

Unit system (imperial, metric) or specific unit used for displaying the area values.

unitOptions SystemOrAreaUnit[]

List of available units and unit systems (imperial, metric) for displaying the area values.

view SceneView

The view from which the widget will operate.

Method Overview

Name Return Type Summary Class

Clears the current measurement.

more details
more detailsAreaMeasurement3DViewModel

Clears the current measurement.

more details
more detailsAreaMeasurement3DViewModel

Starts a new measurement.

more details
more detailsAreaMeasurement3DViewModel

Starts a new measurement.

more details
more detailsAreaMeasurement3DViewModel

Method Details

clear()
Since: ArcGIS API for JavaScript 4.16

Clears the current measurement.

clearMeasurement()
Since: ArcGIS API for JavaScript 4.10
Deprecated since version 4.16. Use clear instead.

Clears the current measurement.

newMeasurement()
Since: ArcGIS API for JavaScript 4.10
Deprecated since version 4.16. Use start instead.

Starts a new measurement.

Example:
const areaMeasurement3DViewModel = new AreaMeasurement3DViewModel({
  view: view,
  unit: "square-meters"
});

function measure () {
  console.log("AreaMeasurement3DViewModel: ", areaMeasurement3DViewModel);
  areaMeasurement3DViewModel.newMeasurement();
}

measure();
start()
Since: ArcGIS API for JavaScript 4.16

Starts a new measurement.

Example:
const areaMeasurement3DViewModel = new AreaMeasurement3DViewModel({
  view: view,
  unit: "square-meters"
});

await areaMeasurement3DViewModel.start();

Type Definitions

MeasurementValue Object

Measurement value.

Properties:
text String

Textual representation of the measured value.

state String

State of the measured value.

Value Description
available measured value is available
unavailable measured value is not available due an incomplete measurement
invalid measured value is not available due to an invalid measurement configuration (e.g. self-intersecting polygon)