Provides the logic for the Measurement widget. Read the Widget development - ViewModel pattern guide topic to get a better understanding of how to use this class.
Constructors
-
new MeasurementViewModel(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | Specifies the current measurement tool to display. more details | MeasurementViewModel | |
AreaMeasurement2DViewModel|AreaMeasurement3DViewModel|DirectLineMeasurement3DViewModel|DistanceMeasurement2DViewModel | View model of the active measurement widget. more details | MeasurementViewModel | |
SystemOrAreaUnit | Unit system (imperial, metric) or specific unit used for displaying the area values. more details | MeasurementViewModel | |
String | The name of the class. more details | Accessor | |
SystemOrLengthUnit | Unit system (imperial, metric) or specific unit used for displaying the distance values. more details | MeasurementViewModel | |
String | The ViewModel's state. more details | MeasurementViewModel | |
MapView|SceneView | A reference to the MapView or SceneView. more details | MeasurementViewModel |
Property Details
-
activeTool String
-
Specifies the current measurement tool to display. Setting its value to
area
activates the area measurement tool and it works for both MapView and SceneView. To measure distance in a MapView set the property todistance
and in a SceneView set it todirect-line
. If this property is not set, the widget will not be displayed.Possible Values:"area"|"distance"|"direct-line"
- Default Value:null
Example// To create the Measurement widget with SceneView's linear measurement widget active. let measurement = new Measurement({ viewModel: { view: view, activeTool: "direct-line" } });
-
View model of the active measurement widget.
Example// Print the active view model to the console. let measurement = new Measurement({ viewModel: { areaUnit: "square-us-feet", view: view, activeTool: "area" } }); console.log("Active ViewModel: ", measurement.viewModel.activeViewModel);
-
areaUnit SystemOrAreaUnit
-
Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are:
metric
,imperial
,square-inches
,square-feet
,square-us-feet
,square-yards
,square-miles
,square-meters
,square-kilometers
,acres
,ares
,hectares
.Example// To create the Measurement widget that displays area in square US feet let measurement = new Measurement({ viewModel: { areaUnit: "square-us-feet", view: view, activeTool: "area" } }); // To display the current measurement unit for area console.log("Current unit: ", measurement.viewModel.areaUnit);
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
linearUnit SystemOrLengthUnit
-
Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are:
metric
,imperial
,inches
,feet
,us-feet
,yards
,miles
,nautical-miles
,meters
,kilometers
.Example// To create the Measurement widget that displays distance in yards let measurement = new Measurement({ viewModel: { linearUnit: "yards", view: view, activeTool: "distance" } }); // To display the current measurement unit for distance console.log('Current unit: ', measurement.viewModel.linearUnit);
-
state Stringreadonly
-
The ViewModel's state.
Value Description disabled not ready yet ready ready for measuring measuring measuring has started measured measuring has finished Possible Values:"disabled"|"ready"|"measuring"|"measured"
- Default Value:disabled
Example// To display the state of the AreaMeasurement2D widget let measurement = new Measurement({ view: view, activeTool: "area" }); measurement.watch("viewModel.state", function(state){ console.log("Current state: ", state); });
-
Example
// Add the measurement widget to the upper right hand corner. const measurement = new Measurement({ viewModel: { view: view, activeTool = "distance"; } }); view.ui.add(measurement, "top-right");
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
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 |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");