import "@arcgis/map-components/components/arcgis-directline-measurement-3d";
DirectLineMeasurement3D component calculates and displays the 3D distance between two points. This component can be used in a SceneView to measure the vertical, horizontal, and direct distance between two points.
Demo
Properties
Property | Attribute | Type |
---|---|---|
analysis readonly |
| |
auto-destroy-disabled | boolean | |
icon | string | |
label | string | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
state readonly | state | "disabled" | "measured" | "measuring" | "ready" |
unit | "centimeters" | "decimeters" | "feet" | "imperial" | "inches" | "kilometers" | "meters" | "metric" | "miles" | "millimeters" | "nautical-miles" | "us-feet" | "yards" | |
| Array<"metric" | "imperial" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"> |
analysis
analysis: DirectLineMeasurementAnalysis
The direct line measurement analysis object being created or modified by the widget.
autoDestroyDisabled
autoDestroyDisabled: boolean
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
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.
- Attribute
- icon
- Default value
- "measure-line"
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
- Attribute
- position
- Default value
- "bottom-left"
referenceElement
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
state
state: "disabled" | "measured" | "measuring" | "ready"
The view model's state.
- Attribute
- state
- Default value
- "disabled"
unit
unit: "centimeters" | "decimeters" | "feet" | "imperial" | "inches" | "kilometers" | "meters" | "metric" | "miles" | "millimeters" | "nautical-miles" | "us-feet" | "yards"
Unit system (imperial, metric) or specific unit used for displaying the distance values.
- Attribute
- unit
unitOptions
unitOptions: Array<"metric" | "imperial" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet">
List of unit systems (imperial, metric) and specific units for displaying the distance values.
Methods
Method | Signature |
---|---|
clear(): Promise<void> | |
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
start(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state" | "analysis"; } | |
undefined |