require(["esri/widgets/UtilityNetworkAssociations/UtilityNetworkAssociationsViewModel"], (UtilityNetworkAssociationsViewModel) => { /* code goes here */ });
import UtilityNetworkAssociationsViewModel from "@arcgis/core/widgets/UtilityNetworkAssociations/UtilityNetworkAssociationsViewModel.js";
esri/widgets/UtilityNetworkAssociations/UtilityNetworkAssociationsViewModel
Provides the logic for the UtilityNetworkAssociations widget.
Constructors
-
new UtilityNetworkAssociationsViewModel(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
SimpleLineSymbol | A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations. more details | UtilityNetworkAssociationsViewModel | |
String | The name of the class. more details | Accessor | |
Boolean | Indicates whether to query and display connectivity associations. more details | UtilityNetworkAssociationsViewModel | |
Boolean | Indicates whether to query and display structural attachment associations. more details | UtilityNetworkAssociationsViewModel | |
Number | The maximum number of associations that can be returned from the server. more details | UtilityNetworkAssociationsViewModel | |
Boolean | Indicates whether to show arrows for connectivity associations. more details | UtilityNetworkAssociationsViewModel | |
Boolean | Indicates whether to show arrows for structural attachment associations. more details | UtilityNetworkAssociationsViewModel | |
String | The view model's state. more details | UtilityNetworkAssociationsViewModel | |
SimpleLineSymbol | A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations. more details | UtilityNetworkAssociationsViewModel | |
UtilityNetwork | Determines the utility network to use. more details | UtilityNetworkAssociationsViewModel | |
MapView | The view associated with the UtilityNetworkAssociations widget instance. more details | UtilityNetworkAssociationsViewModel |
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 }
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes all associations from the map. more details | UtilityNetworkAssociationsViewModel | ||
Removes a group of handles owned by the object. more details | Accessor | ||
Promise<void> | Queries associations within the current map extent. more details | UtilityNetworkAssociationsViewModel |
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");