import "@arcgis/map-components/components/arcgis-utility-network-validate-topology";The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations.
The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.
Properties
| Property | Attribute | Type |
|---|---|---|
autoDestroyDisabled | auto-destroy-disabled | boolean |
extentToValidate | extent-to-validate | "current" | "entire" |
icon | icon | string |
label | label | string |
positiondeprecated | position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" |
referenceElement | reference-element | HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string |
statereadonlyreflected | state | "disabled" | "executing" | "failed" | "loading" | "ready" | "success" |
utilityNetwork | | UtilityNetwork |
view | | MapView |
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
extentToValidate
extentToValidate: "current" | "entire"Specifies the extent of the validation.
- Attribute
- extent-to-validate
- Default value
- "current"
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "check-circle"
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"slot instead.- Attribute
- position
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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.
- Attribute
- reference-element
state
state: "disabled" | "executing" | "failed" | "loading" | "ready" | "success"The current state of the component.
- Attribute
- state
- Default value
- "ready"
view
view: MapViewThe view associated with the component.
Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this
viewproperty which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Utility Network Validate Topology component will be associated with a map or scene component rather than using theviewproperty.
Methods
| Method | Signature |
|---|---|
componentOnReady | componentOnReady(): Promise<void> |
destroy | destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisUtilityNetworkValidateTopology = document.querySelector("arcgis-utility-network-validate-topology");
document.body.append(arcgisUtilityNetworkValidateTopology);
await arcgisUtilityNetworkValidateTopology.componentOnReady();
console.log("arcgis-utility-network-validate-topology is ready to go!");- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
arcgisPropertyChange | CustomEvent<{ name: "state"; }> |
arcgisReady | CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is ready to be interacted with.