The UtilityNetworkAssociations widget class, functioning as a part of the ArcGIS Maps SDK for JavaScript, simplifies the management and manipulation of associations within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations. This widget is specifically designed to create, update, and delete associations between network features, minimizing the amount of code required for such operations. It efficiently handles associations between various utility network elements like junctions, edges, and terminals, providing precise control over the network topology. The UtilityNetworkAssociations widget class empowers developers to streamline their workflow, enhance data integrity, and enable effective network analysis and visualization within utility network applications.
Here is an example of autoRefreshAssociations set to false
.
By clicking the refresh button the associations will appear.
Here is an example of autoRefreshAssociations set to true
.
// Create a new instance of the UtilityNetworkAssociations widget and set
// its required parameters.
const unAssociationsWidget = new UtilityNetworkAssociations({
view: view
});
view.ui.add(unAssociationsWidget, "top-right");
Constructors
-
new UtilityNetworkAssociations(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 |
---|---|---|---|
Boolean | Indicates whether to show a toggle to automatically show associations every time the map extent changes, or an action button to show associations within the current map extent on demand. more details | UtilityNetworkAssociations | |
SimpleLineSymbol | A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations. more details | UtilityNetworkAssociations | |
String|HTMLElement | The ID or node representing the DOM element containing the widget. more details | Widget | |
String | The name of the class. more details | Accessor | |
String | The unique ID assigned to the widget when the widget is created. more details | Widget | |
Boolean | Indicates whether to query and display connectivity associations. more details | UtilityNetworkAssociations | |
Boolean | Indicates whether to query and display structural attachment associations. more details | UtilityNetworkAssociations | |
String | The widget's default label. more details | UtilityNetworkAssociations | |
Number | The maximum number of associations that can be returned from the server. more details | UtilityNetworkAssociations | |
Number | The maximum value or upper bound of the Maximum allowable associations slider. more details | UtilityNetworkAssociations | |
Number | The minimum value or lower bound of the Maximum allowable associations slider. more details | UtilityNetworkAssociations | |
Number | Specifies the interval to move the maximum allowable associations slider with the up, or down keys. more details | UtilityNetworkAssociations | |
Boolean | Indicates whether to show arrows for connectivity associations. more details | UtilityNetworkAssociations | |
Boolean | Indicates whether to show arrows for structural attachment associations. more details | UtilityNetworkAssociations | |
Boolean | When | UtilityNetworkAssociations | |
SimpleLineSymbol | A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations. more details | UtilityNetworkAssociations | |
UtilityNetwork | Determines the utility network to use. more details | UtilityNetworkAssociations | |
MapView | The view associated with the UtilityNetworkAssociations widget instance. more details | UtilityNetworkAssociations | |
UtilityNetworkAssociationsViewModel | The view model for this widget. more details | UtilityNetworkAssociations | |
Boolean | Indicates whether the widget is visible. more details | Widget | |
VisibleElements | The visible elements that are displayed within the widget. more details | UtilityNetworkAssociations |
Property Details
-
autoRefreshAssociations Boolean
-
Indicates whether to show a toggle to automatically show associations every time the map extent changes, or an action button to show associations within the current map extent on demand.
- Default Value:true
-
connectivityAssociationsLineSymbol SimpleLineSymbol
-
A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations.
-
-
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.
Examples// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
-
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
-
label String
-
The widget's default label.
-
maxAllowableAssociations Number
-
The maximum number of associations that can be returned from the server.
- Default Value:250
-
maxAllowableAssociationsSliderMax Number
-
The maximum value or upper bound of the Maximum allowable associations slider.
If the value in the constructor is less than or equal to the value set for maxAllowableAssociationsSliderMin, the property will be set to a default value (1000).
-
maxAllowableAssociationsSliderMin Number
-
The minimum value or lower bound of the Maximum allowable associations slider.
If the value in the constructor is less than 0, the property will be set to a default value (250). If the value in the constructor is greater than or equal to maxAllowableAssociationsSliderMax, the property will be set to a default value (250).
-
maxAllowableAssociationsSliderStep Number
-
Specifies the interval to move the maximum allowable associations slider with the up, or down keys.
-
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
-
showAssociationsEnabled Boolean
-
When
autoRefreshAssociations
istrue
, indicates whether to automatically show associations every time the current map extent changes.- Default Value:false
-
structuralAttachmentAssociationsLineSymbol SimpleLineSymbol
-
A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations.
-
utilityNetwork UtilityNetwork
-
Determines the utility network to use.
-
view MapView
-
The view associated with the UtilityNetworkAssociations widget instance.
-
viewModel UtilityNetworkAssociationsViewModel
-
The view model for this widget.
-
Indicates whether the widget is visible.
If
false
, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of"none"
.- Default Value:true
Example// Hides the widget in the view widget.visible = false;
-
visibleElements VisibleElements
-
The visible elements that are displayed within the widget.
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 | ||
String | A utility method used for building the value for a widget's | Widget | |
Destroys the widget instance. more details | Widget | ||
Boolean | Emits an event on the instance. more details | Widget | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | Widget | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Object | Registers an event handler on the instance. more details | Widget | |
Adds one or more handles which are to be tied to the lifecycle of the widget. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Removes a group of handles owned by the object. more details | Accessor | ||
Object | This method is primarily used by developers when implementing custom widgets. more details | Widget | |
Renders widget to the DOM immediately. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Promise |
| Widget |
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.
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying CSS class setup.Parameterrepeatable The class names.
ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set CSS classes while rendering the widget render() { const dynamicIconClasses = { [CSS.myIcon]: this.showIcon, [CSS.greyIcon]: !this.showIcon }; return ( <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} /> ); }
-
destroy()inherited
-
Destroys the widget instance.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
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"); }
-
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
own(handleOrHandles)inherited
-
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
postInitialize()inherited
-
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
-
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");
-
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
ReturnsType Description Object The rendered virtual node.
-
renderNow()inherited
-
Renders widget to the DOM immediately.
-
scheduleRender()inherited
-
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType Description Promise Returns a new promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Type Definitions
-
VisibleElements Object
-
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
- Property
-
maxAllowableAssociationsSlider Boolean
Indicates whether to display a slider that adjusts the maxAllowableAssociations.
Example// Display the max allowable associations slider using visible elements const unAssociations = new UtilityNetworkAssociations({ view: view, utilityNetwork: utilityNetwork, autoRefreshEnabled: true, visibleElements: { maxAllowableAssociationsSlider: true } });