Direct Line Measurement 3D

The DirectLineMeasurementAnalysis created or modified by the component.

When connecting the Direct Line Measurement 3D component to the Scene component, it automatically creates an empty analysis and adds it to the Scene's analyses collection. Whenever the component is destroyed, the analysis is automatically removed from the collection.

Alternatively, a programmatically created analysis can be provided to the component. Then, the application itself needs to add it to and later remove it from the Scene's analyses collection.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Create the analysis.
const directLineAnalysis = new DirectLineMeasurementAnalysis({
   startPoint: new Point({
     spatialReference: { latestWkid: 3857, wkid: 102100 },
     x: -13624995.61798748,
     y: 4550334.030096778,
     z: 63.378210234455764
   }),
   endPoint: new Point({
     spatialReference: { latestWkid: 3857, wkid: 102100 },
     x: -13624921.53589075,
     y: 4550407.42357004,
     z: 63.3783810287714
   }),
});
// Get the Scene and measurement component and wait until they are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const directLineMeasurement3d = document.querySelector("arcgis-direct-line-measurement-3d");
await directLineMeasurement3d.componentOnReady();
// Add the analysis to the Scene component.
viewElement.analyses.add(directLineAnalysis);
// Connect the analysis to the measurement component:
directLineMeasurement3d.analysis = directLineAnalysis;

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.

Attribute

auto-destroy-disabled

Default value

false

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"measure-line"

The component's default label.

Attribute

label

Attribute

position

Default value

"bottom-left"

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

Attribute

reference-element

The component's state. The values mean the following:

• disabled - not ready yet
• ready - ready for measuring
• measuring - currently measuring
• measured - measuring has finished

Attribute

state

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

Attribute

unit

List of available units and unit systems (imperial, metric) that are shown in the component's dropdown. By default, the following units are included: metric, imperial, inches, feet, us-feet, yards, miles, nautical-miles, meters, kilometers. Possible unit values can only be a subset of this list.

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is is ready to be interacted with.

Clears the current measurement.

Returns

Promise<void>

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
const arcgisDirectLineMeasurement3d = document.querySelector("arcgis-direct-line-measurement-3d");
document.body.append(arcgisDirectLineMeasurement3d);
await arcgisDirectLineMeasurement3d.componentOnReady();
console.log("arcgis-direct-line-measurement-3d is ready to go!");

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

Starts a new measurement.

Returns

Promise<void>