Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/widgets/Measurement"], function(Measurement) { /* code goes here */ });
Class: esri/widgets/Measurement
Inheritance: Measurement Widget Accessor
Since: ArcGIS API for JavaScript 4.13

The Measurement widget groups and manages multiple measurement tools and allows you to easily switch between them using the activeTool property. The tools correspond to the measurement widgets for area and distance in 2D (AreaMeasurement2D, DistanceMeasurement2D) and in 3D (AreaMeasurement3D, DirectLineMeasurement3D).

This widget follows a composite pattern that allows developers to configure the UI to best match their specific requirements. The measurement tools, placements, and icons can all be configured, which offers great flexibility to use with tabbed interfaces or other customized UI. See the Measurement widget sample for an example of this flexibility.

measurement-widget

For 2D MapViews, distances are computed geodetically for geographic coordinate systems and web mercator. For non-web mercator projected coordinate systems, computations will be performed planimetrically for distances up to the threshold distance defined by the geodesicDistanceThreshold property of the widget's ViewModel. Distances equivalent to and beyond the threshold will be computed geodetically. By default the threshold is set to 100km.

For 3D SceneViews, the mode in which distances are computed is either euclidean or geodesic. 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.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
// Add the measurement widget to the upper right hand corner
// with the distance tool active
var map = new Map({
  basemap: "hybrid"
});
var view = new MapView({
  container: "viewDiv",
  map: map,
  center: [-71.69, 43.76],
  zoom: 15
});
var measurement = new Measurement({
  view: view,
  activeTool: "distance"
});
view.ui.add(measurement, "top-right");

// Switch between area and distance measurement
function switchTool() {
 var tool = measurement.activeTool === "distance" ? "area" : "distance";
 measurement.activeTool = tool;
}

Constructors

new Measurement(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

Specifies the current measurement tool to display.

more details
more detailsMeasurement
AreaMeasurement2D|AreaMeasurement3D|DirectLineMeasurement3D|DistanceMeasurement2D

The measurement widget that is currently being used.

more details
more detailsMeasurement
String

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

more details
more detailsMeasurement
String|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
String

The widget's default CSS icon class.

more details
more detailsMeasurement
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's default label.

more details
more detailsMeasurement
String

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

more details
more detailsMeasurement
MapView|SceneView

A reference to the MapView or SceneView.

more details
more detailsMeasurement
MeasurementViewModel

The view model for this widget.

more details
more detailsMeasurement

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 to distance and in a SceneView set it to direct-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 direct-line tool active.
var measurement = new Measurement({
  view: view,
  activeTool: "direct-line"
});

// To switch between direct line and area measurement tools
function switchTool() {
 var tool = measurement.activeTool === "direct-line" ? "area" : "direct-line";
 measurement.activeTool = tool;
}

The measurement widget that is currently being used. Use this property to get access to the active widget.

Default Value:null
Example:
// Print the active widget to the console.
var measurement = new Measurement({
  view: view,
  activeTool: "distance"
});
view.ui.add(measurement, "top-right");
console.log("Active Widget: ", measurement.activeWidget);
areaUnit 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"

Example:
// To create the Measurement widget that displays area in square US feet
var measurement = new Measurement({
  view: view,
  activeTool: "area",
  unit: "square-us-feet"
});

// To display the current measurement unit
console.log("Current unit: ", measurement.unit);

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
declaredClass Stringreadonly inherited

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

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

iconClass Stringreadonly

The widget's default CSS icon class.

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label. This property is useful whenever the widget is controlled by another one (e.g. Expand).

linearUnit 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"

Example:
// To create the Measurement widget that displays distance in yards
var measurement = new Measurement({
  view: view,
  activeTool: "distance",
  linearUnit: "yards"
});

// To display the current measurement unit
console.log('Current linear unit: ', measurement.linearUnit);

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

Example:
// To create the Measurement widget for SceneView with the direct-line tool active.
var measurement = new Measurement({
  view: sceneView,
  activeTool: "direct-line"
});

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the MeasurementViewModel class to access all properties and methods on the widget.

Example:
// Intialize a measurement widget using the view model.
var measurement = new Measurement({
  viewModel: {
    view: view,
    activeTool: "distance",
    unit: "yards"
  }
});

Method Overview

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Removes all measurement widgets and associated graphics.

more details
more detailsMeasurement

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Starts a new measurement for the active measurement widget.

more details
more detailsMeasurement

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:
classNames Array<(string|Array<string>|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
clear()

Removes all measurement widgets and associated graphics.

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
TypeDescription
Booleantrue if a listener was notified
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

startMeasurement()

Starts a new measurement for the active measurement widget.

API Reference search results

NameTypeModule
Loading...