AreaMeasurementLayerView3D

AMD: require(["esri/views/3d/layers/AreaMeasurementLayerView3D"], (AreaMeasurementLayerView3D) => { /* code goes here */ });
ESM: import AreaMeasurementLayerView3D from "@arcgis/core/views/3d/layers/AreaMeasurementLayerView3D";
Class: esri/views/3d/layers/AreaMeasurementLayerView3D
Inheritance: AreaMeasurementLayerView3D LayerView Accessor
Since: ArcGIS API for JavaScript 4.20
beta

The layerview for an AreaMeasurementLayer displays the measurement result in a SceneView. Use the layerview to set the measurement unit to be displayed in the view.

const measurementLayer = new AreaMeasurementLayer({
  geometry: polygon
});

view.whenLayerView(measurementLayer).then(lv => {
  lv.unit = "imperial"
});
See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Layermore details

The layer being viewed.

more detailsLayerView
Booleanmore details

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

more detailsLayerView
Stringmore details For AreaMeasurementLayerView3D the type is always "area-measurement-3d". more detailsAreaMeasurementLayerView3D
SystemOrAreaUnitmore details

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

more detailsAreaMeasurementLayerView3D
Booleanmore details

Value is true when the layer is updating; for example, if it is in the process of fetching data.

more detailsLayerView
Booleanmore details

When true, the layer is visible in the view.

more detailsLayerView

Property Details

declaredClass Stringreadonly inherited

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

layer Layerreadonly inherited

The layer being viewed.

suspended Booleanreadonly inherited

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

type String

For AreaMeasurementLayerView3D the type is always "area-measurement-3d".

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

updating Booleanreadonly inherited

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false
visible Boolean inherited

When true, the layer is visible in the view. Set this property to false to hide the layer from the view.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Booleanmore details

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more detailsLayerView
Booleanmore details

isRejected() may be used to verify if creating an instance of the class is rejected.

more detailsLayerView
Booleanmore details

isResolved() may be used to verify if creating an instance of the class is resolved.

more detailsLayerView
Promisemore details

when() may be leveraged once an instance of the class is created.

more detailsLayerView

Method Details

isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
when(callback, errback){Promise}inherited

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.