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
-
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 |
---|---|---|---|
A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations. | UtilityNetworkAssociationsViewModel | ||
The name of the class. | Accessor | ||
Indicates whether to query and display connectivity associations. | UtilityNetworkAssociationsViewModel | ||
Indicates whether to query and display structural attachment associations. | UtilityNetworkAssociationsViewModel | ||
The maximum number of associations that can be returned from the server. | UtilityNetworkAssociationsViewModel | ||
Indicates whether to show arrows for connectivity associations. | UtilityNetworkAssociationsViewModel | ||
Indicates whether to show arrows for structural attachment associations. | UtilityNetworkAssociationsViewModel | ||
The view model's state. | UtilityNetworkAssociationsViewModel | ||
A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations. | UtilityNetworkAssociationsViewModel | ||
Determines the utility network to use. | UtilityNetworkAssociationsViewModel | ||
The view associated with the UtilityNetworkAssociations widget instance. | UtilityNetworkAssociationsViewModel |
Property Details
-
connectivityAssociationsLineSymbol
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 }
-
includeConnectivityAssociations
includeConnectivityAssociations Boolean
-
Indicates whether to query and display connectivity associations.
- Default Value:true
-
includeStructuralAttachmentAssociations
includeStructuralAttachmentAssociations Boolean
-
Indicates whether to query and display structural attachment associations.
- Default Value:true
-
maxAllowableAssociations
maxAllowableAssociations Number
-
The maximum number of associations that can be returned from the server.
- Default Value:250
-
showArrowsConnectivity
showArrowsConnectivity Boolean
-
Indicates whether to show arrows for connectivity associations.
- Default Value:false
-
showArrowsStructuralAttachment
showArrowsStructuralAttachment Boolean
-
Indicates whether to show arrows for structural attachment associations.
- Default Value:false
-
state
state Stringreadonly
-
The view model's state.
Possible Values:"disabled" |"loading" |"ready" |"executing" |"warning"
- Default Value:disabled
-
structuralAttachmentAssociationsLineSymbol
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 UtilityNetwork
-
Determines the utility network to use.
-
view
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. | Accessor | ||
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
-
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();
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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"); }
-
Inherited from Accessor
-
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");