UtilityNetworkAssociationInput | API Reference | ArcGIS Maps SDK for JavaScript 4.32

See also

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\|null\|undefined	The input's description.	UtilityNetworkAssociationInput
Boolean	Indicates whether the input is editable.	UtilityNetworkAssociationInput
GroupInput\|null\|undefined	The group containing the relationship input.	UtilityNetworkAssociationInput
String	The type of input.	UtilityNetworkAssociationInput
Boolean	Indicates whether the form is currently updating.	UtilityNetworkAssociationInput

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.

description Property description String |null |undefinedreadonly

The input's description.

editable Property editable Booleanreadonly

Indicates whether the input is editable.

group Property group GroupInput |null |undefinedreadonly

The group containing the relationship input.

type Property type Stringreadonly

The type of input.

For UtilityNetworkAssociationInput the type is always "utilityNetworkAssociations".

updating Property updating Booleanreadonly

Indicates whether the form is currently updating.

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
Promise	Refreshes the associations view model for this Input.	UtilityNetworkAssociationInput
	Removes a group of handles owned by the object.	Accessor

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");
}

refresh Method refresh(){Promise}

Refreshes the associations view model for this Input.

Re-queries the count of associated features for each association type, as well as the associated features for any open association type.

Returns

Type	Description
Promise	Resolves when the view model finishes querying its associated features.

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");