import "@arcgis/map-components/components/arcgis-area-measurement-2d";AreaMeasurement2D component calculates and displays the area and perimeter of a polygon only in a MapView.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
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 | |
| ||
statereadonly | state | "disabled" | "measured" | "measuring" | "ready" |
unit | "acres" | "ares" | "hectares" | "imperial" | "metric" | "square-centimeters" | "square-decimeters" | "square-feet" | "square-inches" | "square-kilometers" | "square-meters" | "square-miles" | "square-millimeters" | "square-nautical-miles" | "square-us-feet" | "square-yards" | |
| Array<"metric" | "imperial" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-nautical-miles" | "square-us-feet" | "acres" | "ares" | "hectares"> |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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: stringIcon 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-area"
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 ViewModel's state.
- Attribute
- state
- Default value
- "disabled"
unit
unit: "acres" | "ares" | "hectares" | "imperial" | "metric" | "square-centimeters" | "square-decimeters" | "square-feet" | "square-inches" | "square-kilometers" | "square-meters" | "square-miles" | "square-millimeters" | "square-nautical-miles" | "square-us-feet" | "square-yards"Unit system (imperial, metric) or specific unit used for displaying the area values.
- Attribute
- unit
unitOptions
unitOptions: Array<"metric" | "imperial" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-nautical-miles" | "square-us-feet" | "acres" | "ares" | "hectares">List of available units and unit systems (imperial, metric) for displaying the area values.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
{ name: "state"; } | |
undefined |
arcgisPropertyChange
arcgisPropertyChange: { name: "state"; }Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: undefinedEmitted when the component associated with a map view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.