Skip To ContentArcGIS for DevelopersSign In Dashboard

DirectLineMeasurement3D

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

The DirectLineMeasurement3D widget calculates and displays the 3D distance between two points. This widget can be used in a SceneView to measure the vertical, horizontal, and direct distance between two points.

measurement-line-3d

When the widget is active, a horizontal "laser" line is drawn which indicates the height at the current mouse position. This line can help in analyzing the heights of objects relative to each other and the terrain. A second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.

DirectLineMeasurement3D widget labels the direct, horizontal, and vertical orange distance lines and displays the same values in the UI panel. In a WGS84 or WebMercator scene, when the distance between the points is greater than 100 km, DirectLineMeasurement3D widget switches to displaying only the Horizontal and Vertical distances taking into consideration the curvature of the earth (i.e. ellipsoid-based geodesic distance).

measurement-line-3d

Known Limitations

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

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
var measurementWidget = new DirectLineMeasurement3D({
  view: view
});

view.ui.add(measurementWidget, "top-right");

Constructors

new DirectLineMeasurement3D(properties)
Parameter:
properties Object
optional

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

Example:
// typical usage
var measurementWidget = new DirectLineMeasurement3D({
  view: view
});

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 unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's label.

more details
more detailsWidget
String

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

more details
more detailsDirectLineMeasurement3D
String[]

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

more details
more detailsDirectLineMeasurement3D
SceneView

A reference to the SceneView.

more details
more detailsDirectLineMeasurement3D
DirectLineMeasurement3DViewModel

The view model for this widget.

more details
more detailsDirectLineMeasurement3D

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
Since: ArcGIS API for JavaScript 4.7

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.

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.

Since: ArcGIS API for JavaScript 4.11

The widget's label.

This property is useful whenever the widget is controlled by another one (e.g. Expand)

unit String
Since: ArcGIS API for JavaScript 4.8

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[]
Since: ArcGIS API for JavaScript 4.7

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.

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

Since: ArcGIS API for JavaScript 4.7

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

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
Since: ArcGIS API for JavaScript 4.7

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...