AreaMeasurement2DViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.33

Provides the logic for the AreaMeasurement2D widget and component.

See also

Constructors

AreaMeasurement2DViewModel Constructor new AreaMeasurement2DViewModel(properties)

Parameter

properties Object

optional

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

Property Overview

Type	Summary	Class
Object\|null\|undefined	The area and perimeter of the measurement polygon in square meters and meters respectively.	AreaMeasurement2DViewModel
Object\|null\|undefined	This property returns the locale specific representation of the area and perimeter.	AreaMeasurement2DViewModel
SnappingOptions	The SnappingOptions for sketching.	AreaMeasurement2DViewModel
String	The ViewModel's state.	AreaMeasurement2DViewModel
SystemOrAreaUnit	Unit system (imperial, metric) or specific unit used for displaying the area values.	AreaMeasurement2DViewModel
SystemOrAreaUnit []	List of available units and unit systems (imperial, metric) for displaying the area values.	AreaMeasurement2DViewModel
MapView\|null\|undefined	The view from which the widget will operate.	AreaMeasurement2DViewModel

Property Details

measurement Property measurement Object |null |undefinedreadonly

The area and perimeter of the measurement polygon in square meters and meters respectively.

Properties: area Number

The area (m²).

perimeter Number

The perimeter (m).

geometry Polygon

Measurement area.

Example

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

// Raw measurements (in meters) can be accessed from this property
reactiveUtils.watch(
() => measurementWidget.viewModel.measurement,
  (measurement) => {
    console.log(
       "Area: ", measurement.area,
       "Perimeter: ", measurement.perimeter
    );
  }
);

measurementLabel Property measurementLabel Object |null |undefinedreadonly

This property returns the locale specific representation of the area and perimeter. Areas and perimeters are rounded to two decimal places. Areas are sourced from the measurement property (in square meters) and converted to the user defined units/system.

Properties: area String

The area (m²).

perimeter String

The perimeter (m).

Example

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

// Measurement labels can be accessed from this property
reactiveUtils.watch(
() => measurementWidget.viewModel.measurementLabel,
  (label) => {
    console.log(
       "Area: ", label.area,
       "Perimeter: ", label.perimeter
    );
  }
);

snappingOptions Property snappingOptions SnappingOptionsautocast Since: ArcGIS Maps SDK for JavaScript 4.32 AreaMeasurement2DViewModel since 4.10, snappingOptions added at 4.32. beta

The SnappingOptions for sketching. It supports self and feature snapping.

state Property 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 measurementWidget = new AreaMeasurement2D({
  view: view
});
reactiveUtils.watch(
  () => measurementWidget.viewModel.state,
  (state) => console.log("Current state: ", state)
);

unit Property unit SystemOrAreaUnit

Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in unitOptions.

Example

// To create the AreaMeasurement2D widget that displays area in square US feet
let measurementWidget = new AreaMeasurement2D({
  viewModel: {
    view: view,
    unit: "square-us-feet"
  }
});

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

unitOptions Property unitOptions SystemOrAreaUnit[]

List of available units and unit systems (imperial, metric) for displaying the area values. By default, the following units are included: metric, imperial, square-inches, square-feet, square-us-feet, square-yards, square-miles, square-meters, square-kilometers, acres, ares, hectares. Possible unit values can only be a subset of this list.

Example

// To display the available units to the console
let measurementWidget = new AreaMeasurement2D({
  view: view
});
console.log('All units: ', measurementWidget.viewModel.unitOptions.join(", "));

view Property view MapView |null |undefined

The view from which the widget will operate.

Example

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

Method Overview

Name	Return Type	Summary	Class
		Clears the current measurement.	AreaMeasurement2DViewModel
		Starts a new measurement.	AreaMeasurement2DViewModel

Method Details

clear Method clear() Since: ArcGIS Maps SDK for JavaScript 4.16 AreaMeasurement2DViewModel since 4.10, clear added at 4.16.

Clears the current measurement.

start Method start() Since: ArcGIS Maps SDK for JavaScript 4.16 AreaMeasurement2DViewModel since 4.10, start added at 4.16.

Starts a new measurement.

Example

const areaMeasurement2DViewModel = new AreaMeasurement2DViewModel({
  view: view,
  unit: "square-yards"
});

await areaMeasurement2DViewModel.start();