UtilityNetworkAssociationsViewModel

AMD: require(["esri/widgets/UtilityNetworkAssociations/UtilityNetworkAssociationsViewModel"], (UtilityNetworkAssociationsViewModel) => { /* code goes here */ });
ESM: import UtilityNetworkAssociationsViewModel from "@arcgis/core/widgets/UtilityNetworkAssociations/UtilityNetworkAssociationsViewModel.js";
Class: esri/widgets/UtilityNetworkAssociations/UtilityNetworkAssociationsViewModel
Inheritance: UtilityNetworkAssociationsViewModel Accessor
Since: ArcGIS Maps SDK for JavaScript 4.26

Provides the logic for the UtilityNetworkAssociations widget.

See also

Constructors

UtilityNetworkAssociationsViewModel

Constructor
new UtilityNetworkAssociationsViewModel(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
SimpleLineSymbol

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

UtilityNetworkAssociationsViewModel
String

The name of the class.

Accessor
Boolean

Indicates whether to query and display connectivity associations.

UtilityNetworkAssociationsViewModel
Boolean

Indicates whether to query and display structural attachment associations.

UtilityNetworkAssociationsViewModel
Number

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

UtilityNetworkAssociationsViewModel
Boolean

Indicates whether to show arrows for connectivity associations.

UtilityNetworkAssociationsViewModel
Boolean

Indicates whether to show arrows for structural attachment associations.

UtilityNetworkAssociationsViewModel
String

The view model's state.

UtilityNetworkAssociationsViewModel
SimpleLineSymbol

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

UtilityNetworkAssociationsViewModel
UtilityNetwork

Determines the utility network to use.

UtilityNetworkAssociationsViewModel
MapView

The view associated with the UtilityNetworkAssociations widget instance.

UtilityNetworkAssociationsViewModel

Property Details

connectivityAssociationsLineSymbol

Property
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

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

includeConnectivityAssociations

Property
includeConnectivityAssociations Boolean

Indicates whether to query and display connectivity associations.

Default Value:true

includeStructuralAttachmentAssociations

Property
includeStructuralAttachmentAssociations Boolean

Indicates whether to query and display structural attachment associations.

Default Value:true

maxAllowableAssociations

Property
maxAllowableAssociations Number

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

Default Value:250

showArrowsConnectivity

Property
showArrowsConnectivity Boolean

Indicates whether to show arrows for connectivity associations.

Default Value:false

showArrowsStructuralAttachment

Property
showArrowsStructuralAttachment Boolean

Indicates whether to show arrows for structural attachment associations.

Default Value:false

state

Property
state Stringreadonly

The view model's state.

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

Default Value:disabled

structuralAttachmentAssociationsLineSymbol

Property
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

Property
utilityNetwork UtilityNetwork

Determines the utility network to use.

view

Property
view MapView

The view associated with the UtilityNetworkAssociations widget instance.

Method Overview

Show inherited methods Hide inherited methods
Name 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 all associations from the map.

UtilityNetworkAssociationsViewModel

Removes a group of handles owned by the object.

Accessor
Promise<void>

Queries associations within the current map extent.

UtilityNetworkAssociationsViewModel

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

removeAssociations

Method
removeAssociations()

Removes all associations from the map.

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

showAssociations

Method
showAssociations(){Promise<void>}

Queries associations within the current map extent.

Returns
Type Description
Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.