arcgis-utility-network-validate-topology | References

ESM

import "@arcgis/map-components/components/arcgis-utility-network-validate-topology";

Inheritance: ArcgisUtilityNetworkValidateTopology→HTMLElement

This component is deprecated. arcgis-utility-network-validate-network-topology is the preferred component for validating utility network topology and should be used for all new development.

The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface.

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	UtilityNetworkValidateTopologyExtentOption
icon	icon	Icon["icon"]
label	label	string
referenceElement	reference-element	ArcgisReferenceElement \| string \| undefined
state readonly		UtilityNetworkValidateTopologyViewModelState
utilityNetwork		UtilityNetwork \| null \| undefined
view		MapView \| null \| undefined

autoDestroyDisabled

Property

Type: 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

extentToValidate

Property

Type: UtilityNetworkValidateTopologyExtentOption

Specifies the extent of the validation.

Attribute: extent-to-validate
Default value: "current"

icon

autocast Property

Type: Icon["icon"]

Since: ArcGIS Maps SDK for JavaScript 4.27

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: "check-circle"

label

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 4.11

The component's default label.

Attribute: label

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

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

state

readonly Property

Type: UtilityNetworkValidateTopologyViewModelState

Since: ArcGIS Maps SDK for JavaScript 4.27

The current state of the component.

Default value: "ready"

utilityNetwork

Property

Type: UtilityNetwork | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

Determines the utility network to use.

view

Property

Type: MapView | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

The 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 view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-validate-topology component will be associated with a map or scene component rather than using the view property.

Methods

Method	Signature
componentOnReady inherited	componentOnReady(): Promise<this>
destroy	destroy(): Promise<void>

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: this

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisUtilityNetworkValidateTopology = document.createElement("arcgis-utility-network-validate-topology");
document.body.append(arcgisUtilityNetworkValidateTopology);
await arcgisUtilityNetworkValidateTopology.componentOnReady();
console.log("arcgis-utility-network-validate-topology is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
arcgisPropertyChange	CustomEvent<{ name: "state"; }>
arcgisReady	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state"; }>

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

arcgisReady

Event

arcgisReady: CustomEvent<void>

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