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.
NameTypeSummaryClass
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
String

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

more details
more detailsAreaMeasurement3DViewModel
String[]

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.

ValueDescription
disablednot ready yet
readyready for measuring
measuringcurrently measuring
measuredmeasuring has finished
Default Value:disabled
unit String

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

Possible Values: metric | imperial | square-inches | square-feet | square-us-feet | square-yards | square-miles | square-meters | square-kilometers | acres | ares | hectares

unitOptions String[]

List of available units and unit systems (imperial, metric) for displaying the area values. By default, the following units are included: metric, imperial, square-inches, square-feet, square-us-feet, square-yards, square-miles, square-meters, square-kilometers, acres, ares, hectares.

The view from which the widget will operate.

Method Overview

NameReturn TypeSummaryClass

Clears the current measurement.

more details
more detailsAreaMeasurement3DViewModel

Starts a new measurement.

more details
more detailsAreaMeasurement3DViewModel

Method Details

clearMeasurement()
Since: ArcGIS API for JavaScript 4.10

Clears the current measurement.

newMeasurement()
Since: ArcGIS API for JavaScript 4.10

Starts a new measurement.

Type Definitions

MeasurementValue Object

Measurement value.

Properties:
text String

Textual representation of the measured value.

state String

State of the measured value.

ValueDescription
availablemeasured value is available
unavailablemeasured value is not available due an incomplete measurement
invalidmeasured value is not available due to an invalid measurement configuration (e.g. self-intersecting polygon)

API Reference search results

NameTypeModule
Loading...