Property Overview

Property Details

geodesicDistanceThreshold Number

When the coordinate sustem is projected (other than web mercator) then distances less than this threshold will be computed planimetrically. Otherwise distances will be computed geodetically.

Default Value:100000

Example:

// To set the threshold at 10 km
var measurementWidget = new DistanceMeasurement2D({
  viewModel: {
    view: view,
    geodesicDistanceThreshold: 10000
  }
});

measurement Objectreadonly

The length and geometry of the measurement polyline in meters.

Properties:

length Number Line length (m).

geometry Polyline Measurement line.

Example:

// After creating and adding the DistanceMeasurement2D widget
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

// Raw measurements (in meters) can be accessed from this property
measurementWidget.watch("viewModel.measurement", function(measurement) {
  console.log(
    "Length: ", measurement.length,
    "Geometry: ", measurement.geometry
  );
});

measurementLabel Stringreadonly

This property returns the locale specific representation of the length. Lengths are rounded to two decimal places. Lengths are sourced from the measurement property (in meters) and converted to the user defined units or system.

Example:

// After creating and adding the DistanceMeasurement2D widget
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

// The measurement label can be accessed from this property
measurementWidget.watch("viewModel.measurementLabel", function(label) {
  console.log(
     "Label: ", label
  );
});

state Stringreadonly

The view model'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 DistanceMeasurement2D widget
var measurementWidget = new DistanceMeasurement2D({
  view: view
});
measurementWidget.watch("viewModel.state", function(state){
  console.log("Current state: ", state);
});

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({
  viewModel: {
    view: view,
    unit: "yards"
  }
});

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

unitOptions String[]

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

Possible Values:"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.viewModel.unitOptions.join(", "));

view MapView

The view from which the widget will operate.

Example:

// To create DistanceMeasurement2D widget with the view property
var measurementWidget = new DistanceMeasurement2D({
  viewModel: {
    view: view
  }
});

Method Overview

Method Details

clearMeasurement()

Clears the current measurement.

newMeasurement()

Starts a new measurement.

Example:

const distanceMeasurement2DViewModel = new DistanceMeasurement2DViewModel({
  view: view,
  unit: "us-feet"
});

function measure () {
  console.log("DistanceMeasurement2DViewModel: ", distanceMeasurement2DViewModel);
  distanceMeasurement2DViewModel.newMeasurement();
}

measure();