Skip To ContentArcGIS for DevelopersSign In Dashboard

DistanceMeasurement2D

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

The DistanceMeasurement2D widget calculates and displays the distance between two or more points in a MapView. When the distance is less than 100 km, the default mode is planar. When the distance is greater than or equal to 100 km, the default mode is geodesic.

measurement-line-2d

Undo / Redo

GestureAction
ZIncrementally undos actions recorded in the stack.
RIncrementally redos actions recorded in the stack.

Known Limitations

This widget is designed to work with 2D MapViews. For measurements with 3D SceneViews, use DirectLineMeasurement3D

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
// To add the DistanceMeasurement2D widget to the map
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

Constructors

new DistanceMeasurement2D(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// To add the DistanceMeasurement2D widget to the map
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
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 detailsDistanceMeasurement2D
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 detailsDistanceMeasurement2D
String

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

more details
more detailsDistanceMeasurement2D
String[]

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

more details
more detailsDistanceMeasurement2D
MapView

A reference to the MapView.

more details
more detailsDistanceMeasurement2D
DistanceMeasurement2DViewModel

The view model for this widget.

more details
more detailsDistanceMeasurement2D

Property Details

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 programatically 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 String

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.

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

Example:
// To create the DistanceMeasurement2D widget that displays distance in yards
var measurementWidget = new DistanceMeasurement2D({
  view: view,
  unit: "yards"
});

// To display the current measurement unit
console.log('Current unit: ', measurementWidget.unit);
unitOptions String[]

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

Example:
// To display the available units to the console
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
console.log('All units: ', measurementWidget.unitOptions.join(", "));
view MapView

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

Example:
// Typical usage
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

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 DistanceMeasurement2DViewModel class to access all properties and methods on the widget.

Example:
// Use the ViewModel to access and set advanced settings
var measurementWidget = new DistanceMeasurement2D({
  viewModel: {
    view: view,
    mode: "planar",
    unit: "feet"
  }
});
view.ui.add(measurementWidget, "top-right");

Method Overview

NameReturn TypeSummaryClass
String

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

more details
more detailsWidget

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

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 (String|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)} />
  );
}
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.

API Reference search results

NameTypeModule
Loading...