UtilityNetworkValidateTopologyViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.33

Provides the logic for the UtilityNetworkValidateTopology widget and component.

See also

Constructors

UtilityNetworkValidateTopologyViewModel Constructor new UtilityNetworkValidateTopologyViewModel(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String	If the validation process fails, this property returns an error message.	UtilityNetworkValidateTopologyViewModel
String	Specifies the extent of the validation.	UtilityNetworkValidateTopologyViewModel
Collection<string>	If an error occurs during during validation a loadError wil be displayed.	UtilityNetworkValidateTopologyViewModel
String	The view model's state.	UtilityNetworkValidateTopologyViewModel
UtilityNetwork\|null\|undefined	Determines the utility network to use.	UtilityNetworkValidateTopologyViewModel
MapView\|null\|undefined	The view from which the widget will operate.	UtilityNetworkValidateTopologyViewModel

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

executionError Property executionError Stringreadonly

If the validation process fails, this property returns an error message. Otherwise, it is empty.

extentToValidate Property extentToValidate String

Specifies the extent of the validation.

Possible Values:"current" |"entire"

Default Value:"current"

loadErrors Property loadErrors Collection<string>autocast

If an error occurs during during validation a loadError wil be displayed.

state Property state Stringreadonly

The view model's state.

Default Value:"ready"

utilityNetwork Property utilityNetwork UtilityNetwork |null |undefined

Determines the utility network to use.

view Property view MapView |null |undefined

The view from which the widget will operate.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
	Validates the network topology of the utility network.	UtilityNetworkValidateTopologyViewModel

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

validateTopology Method validateTopology()

Validates the network topology of the utility network.

See also

UtilityNetwork