Skip To ContentArcGIS for DevelopersSign In Dashboard

DirectLineMeasurement3DViewModel

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

Provides the logic for the DirectLineMeasurement3D widget.

See also:

Constructors

new DirectLineMeasurement3DViewModel(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 calculated between the two points.

more details
more detailsDirectLineMeasurement3DViewModel
String

The view model's state.

more details
more detailsDirectLineMeasurement3DViewModel
String

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

more details
more detailsDirectLineMeasurement3DViewModel
String[]

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

more details
more detailsDirectLineMeasurement3DViewModel
SceneView

The view from which the widget will operate.

more details
more detailsDirectLineMeasurement3DViewModel

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 calculated between the two points.

Properties:
measurementMode String

Describes the mode in which the measurement was taken. In euclidean mode, the distances are measured as straight lines in the ECEF coordinate system. In geodesic mode, the distances are measured as geodesic lines on the WGS84 ellipsoid.

Possible Values:"euclidean"|"geodesic"

directDistance MeasurementValue

The direct distance between the two points.

horizontalDistance MeasurementValue

The horizontal distance between the two points.

verticalDistance MeasurementValue

The vertical distance between the two points.

state Stringreadonly

The view model's state.

ValueDescription
disablednot ready yet
readyready for measuring
measuringcurrently measuring
measuredmeasuring has finished

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

Default Value:disabled
unit String

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

Possible Values:"metric"|"imperial"|"inches"|"feet"|"us-feet"|"yards"|"miles"|"nautical-miles"|"meters"|"kilometers"

unitOptions String[]

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

Possible Values:"metric"|"imperial"|"inches"|"feet"|"us-feet"|"yards"|"miles"|"nautical-miles"|"meters"|"kilometers"

The view from which the widget will operate.

Method Overview

NameReturn TypeSummaryClass

Clears the current measurement.

more details
more detailsDirectLineMeasurement3DViewModel

Clears the current measurement.

more details
more detailsDirectLineMeasurement3DViewModel

Starts a new measurement.

more details
more detailsDirectLineMeasurement3DViewModel

Starts a new measurement.

more details
more detailsDirectLineMeasurement3DViewModel

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 directLineMeasurement3D = new DirectLineMeasurement3D({
  view: view,
  unit: "kilometers"
});

function measure () {
  console.log("DirectLineMeasurement3D: ", directLineMeasurement3D);
  directLineMeasurement3D.newMeasurement();
}

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

Starts a new measurement.

Example:
const directLineMeasurement3D = new DirectLineMeasurement3D({
  view: view,
  unit: "kilometers"
});

await directLineMeasurement3D.start();

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 or because the value is not available for the given measurement configuration (e.g. direct distance is unavailable in geodesic mode)

API Reference search results

NameTypeModule
Loading...