UtilityNetworkAssociationsViewModel

Property Overview

Property Details

connectivityAssociationsLineSymbol SimpleLineSymbol

A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations.

The default value is the following:

{
  type: "simple-line",
  color: [190, 159, 159, 1],
  style: "short-dash",
  width: 2
}

declaredClass Stringreadonly inherited

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

includeConnectivityAssociations Boolean

Indicates whether to query and display connectivity associations.

Default Value:true

includeStructuralAttachmentAssociations Boolean

Indicates whether to query and display structural attachment associations.

Default Value:true

maxAllowableAssociations Number

The maximum number of associations that can be returned from the server.

Default Value:250

showArrowsConnectivity Boolean

Indicates whether to show arrows for connectivity associations.

Default Value:false

showArrowsStructuralAttachment Boolean

Indicates whether to show arrows for structural attachment associations.

Default Value:false

state Stringreadonly

The view model's state.

Possible Values:"disabled"|"loading"|"ready"|"executing"|"warning"

Default Value:disabled

structuralAttachmentAssociationsLineSymbol SimpleLineSymbol

A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations. *

The default value is the following:

{
  type: "simple-line",
  color: [159, 190, 159, 1],
  style: "short-dash",
  width: 2
}

utilityNetwork UtilityNetwork

Determines the utility network to use.

view MapView

The view associated with the UtilityNetworkAssociations widget instance.

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

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(groupKey){Boolean}inherited

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

removeAssociations()

Removes all associations from the map.

removeHandles(groupKey)inherited

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

showAssociations(){Promise<void>}

Queries associations within the current map extent.

Returns

Type	Description
Promise<void>