DirectLineMeasurement3DViewModel

AMD: require(["esri/widgets/DirectLineMeasurement3D/DirectLineMeasurement3DViewModel"], (DirectLineMeasurement3DViewModel) => { /* code goes here */ });
ESM: import DirectLineMeasurement3DViewModel from "@arcgis/core/widgets/DirectLineMeasurement3D/DirectLineMeasurement3DViewModel";
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.
Show inherited properties Hide inherited properties
Name Type Summary Class
DirectLineMeasurementAnalysis

The direct line measurement analysis object being created or modified by the view model.

more details
DirectLineMeasurement3DViewModel
String

The name of the class.

more details
Accessor
Object

The current measurement calculated between the two points.

more details
DirectLineMeasurement3DViewModel
String

The view model's state.

more details
DirectLineMeasurement3DViewModel
SystemOrLengthUnit

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

more details
DirectLineMeasurement3DViewModel
SystemOrLengthUnit[]

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

more details
DirectLineMeasurement3DViewModel
SceneView

The view from which the widget will operate.

more details
DirectLineMeasurement3DViewModel

Property Details

Since: ArcGIS API for JavaScript 4.23

The direct line measurement analysis object being created or modified by the view model.

This property can be set during view model construction, to provide an existing analysis to the view model for modification. Properties on the analysis can also be updated once it's assigned to the view model.

If no analysis is provided during view model construction, the view model automatically creates its own analysis and adds it to the view. In this case, the analysis will also be automatically removed from the view when the view model is destroyed.

Example
// Construct a direct line measurement analysis object outside of the view model
const analysis = new DirectLineMeasurementAnalysis({
  startPoint: {
    type: "point", // autocasts as new Point()
    x: 7.67,
    y: 45.981,
    z: 3435.765
  },
  endPoint: {
    type: "point",
    x: 7.659,
    y: 45.976,
    z: 4437
  }
});

// Ensure that the analysis is added to the view
view.analyses.add(analysis);

// Frame the analysis in the view
view.goTo(analysis.extent);

// Pass the analysis object as a constructor parameter to modify it using the view model
const viewModel = new DirectLineMeasurement3DViewModel({
  analysis: analysis,
  view: view
});
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, only available in euclidean mode.

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.

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 distance values. Possible values are listed in unitOptions.

unitOptions SystemOrLengthUnit[]

List of unit systems (imperial, metric) and specific units for displaying the distance values. By default, the following units are included: metric, imperial, inches, feet, us-feet, yards, miles, nautical-miles, meters, kilometers. Possible unit values can only be a subset of this list.

view SceneView

The view from which the widget will operate.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor

Clears the current measurement.

more details
DirectLineMeasurement3DViewModel
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Starts a new measurement.

more details
DirectLineMeasurement3DViewModel

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

clear()
Since: ArcGIS API for JavaScript 4.16

Clears the current measurement.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

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(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

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");
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.

Value Description
available measured value is available
unavailable measured 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)

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.