UtilityNetworkAssociations | API Reference | ArcGIS Maps SDK for JavaScript 4.30

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. 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. UtilityNetworkAssociations-autoRefresh-false

By clicking the refresh button the associations will appear. UtilityNetworkAssociations-autoRefresh-false-manual-refresh

Here is an example of autoRefreshAssociations set to true. UtilityNetworkAssociations-autoRefresh-true

See also

Example

// 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

UtilityNetworkAssociations Constructor new UtilityNetworkAssociations(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

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.	UtilityNetworkAssociations
SimpleLineSymbol	A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations.	UtilityNetworkAssociations
String\|HTMLElement	The ID or node representing the DOM element containing the widget.	Widget
String	The name of the class.	Accessor
String	Icon displayed in the widget's button.	UtilityNetworkAssociations
String	The unique ID assigned to the widget when the widget is created.	Widget
Boolean	Indicates whether to query and display connectivity associations.	UtilityNetworkAssociations
Boolean	Indicates whether to query and display structural attachment associations.	UtilityNetworkAssociations
String	The widget's default label.	UtilityNetworkAssociations
Number	The maximum number of associations that can be returned from the server.	UtilityNetworkAssociations
Number	The maximum value or upper bound of the Maximum allowable associations slider.	UtilityNetworkAssociations
Number	The minimum value or lower bound of the Maximum allowable associations slider.	UtilityNetworkAssociations
Number	Specifies the interval to move the maximum allowable associations slider with the up, or down keys.	UtilityNetworkAssociations
Boolean	Indicates whether to show arrows for connectivity associations.	UtilityNetworkAssociations
Boolean	Indicates whether to show arrows for structural attachment associations.	UtilityNetworkAssociations
Boolean	When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations every time the current map extent changes.	UtilityNetworkAssociations
SimpleLineSymbol	A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations.	UtilityNetworkAssociations
UtilityNetwork	Determines the utility network to use.	UtilityNetworkAssociations
MapView	The view associated with the UtilityNetworkAssociations widget instance.	UtilityNetworkAssociations
UtilityNetworkAssociationsViewModel	The view model for this widget.	UtilityNetworkAssociations
Boolean	Indicates whether the widget is visible.	Widget
VisibleElements	The visible elements that are displayed within the widget.	UtilityNetworkAssociations

Property Details

autoRefreshAssociations Property 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 Property connectivityAssociationsLineSymbol SimpleLineSymbol

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

container Inherited Property container String |HTMLElement Inherited from Widget

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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

icon Property icon String Since: ArcGIS Maps SDK for JavaScript 4.27 UtilityNetworkAssociations since 4.26, icon added at 4.27.

Icon displayed in the widget's button.

Default Value:"view-associations"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

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 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

label Property label String

The widget's default label.

maxAllowableAssociations Property maxAllowableAssociations Number

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

Default Value:250

maxAllowableAssociationsSliderMax Property 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 Property 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 Property maxAllowableAssociationsSliderStep Number

Specifies the interval to move the maximum allowable associations slider with the up, or down keys.

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

showAssociationsEnabled Property showAssociationsEnabled Boolean

When autoRefreshAssociations is true, indicates whether to automatically show associations every time the current map extent changes.

Default Value:false

structuralAttachmentAssociationsLineSymbol Property structuralAttachmentAssociationsLineSymbol SimpleLineSymbol

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

utilityNetwork Property utilityNetwork UtilityNetwork

Determines the utility network to use.

view Property view MapView

The view associated with the UtilityNetworkAssociations widget instance.

viewModel Property viewModel UtilityNetworkAssociationsViewModel

The view model for this widget.

visible Inherited Property visible Boolean Inherited from 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 Property visibleElements VisibleElements

The visible elements that are displayed within the widget.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
String	A utility method used for building the value for a widget's `class` property.	Widget
	Destroys the widget instance.	Widget
Boolean	Emits an event on the instance.	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Widget
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Widget
Object	Registers an event handler on the instance.	Widget
	Adds one or more handles which are to be tied to the lifecycle of the widget.	Widget
	Executes after widget is ready for rendering.	Widget
	Removes a group of handles owned by the object.	Accessor
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
	Schedules widget rendering.	Widget
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

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.

classes Inherited Method classes(classNames){String} Inherited from Widget

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter

classNames String|String []|Object

repeatable

The class names.

Returns

Type	Description
String	The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy Inherited Method destroy() Inherited from Widget

Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean} Inherited from Widget

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

hasEventListener Inherited Method hasEventListener(type){Boolean} Inherited from Widget

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

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

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Widget

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.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Inherited from Widget

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Inherited from Widget

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on Inherited Method on(type, listener){Object} Inherited from Widget

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type 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.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own Inherited Method own(handleOrHandles) Inherited from Widget Deprecated since 4.28 Use addHandles() instead.

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.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

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

render Inherited Method render(){Object} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

when Inherited Method when(callback, errback){Promise} Inherited from Widget

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	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 Type Definition 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.

Properties

connectivityAssociationsSettings Object

optional

The connectivity associations' line symbol settings that can be further configured.

Specification: arrowsToggle Boolean

optional
Indicates whether to display a toggle to hide / show arrows for connectivity associations. Default is true.

capSelect Boolean

optional
Indicates whether to display the cap input to update the line symbol's cap style. Default is true.

colorPicker Boolean

optional
Indicates whether to display the color picker to update the line symbol's color. Default is true.

stylePicker Boolean

optional
Indicates whether to display the style input to update the line symbol's style. Default is true.

widthInput Boolean

optional
Indicates whether to display the width input to update the line symbol's width. Default is true.

maxAllowableAssociationsSlider Boolean

Indicates whether to display a slider that adjusts the maxAllowableAssociations.

structuralAttachmentAssociationsSettings Object

optional

The structural attachment associations' line symbol settings that can be further configured.

Specification: arrowsToggle Boolean

optional
Indicates whether to display a toggle to hide / show arrows for structural attachment associations. Default is true.

capSelect Boolean

optional
Indicates whether to display the cap input to update the line symbol's cap style. Default is true.

colorPicker Boolean

optional
Indicates whether to display the color picker to update the line symbol's color. Default is true.

stylePicker Boolean

optional
Indicates whether to display the style input to update the line symbol's style. Default is true.

widthInput Boolean

optional
Indicates whether to display the width input to update the line symbol's width. Default is true.

Example

// Display the max allowable associations slider using visible elements
const unAssociations = new UtilityNetworkAssociations({
  view: view,
   utilityNetwork: utilityNetwork,
   autoRefreshEnabled: true,
   visibleElements: {
    connectivityAssociationsSettings: {
      arrowsToggle: false,
      capSelect: false,
      colorPicker: true,
      stylePicker: true,
      widthInput: true
    },
     maxAllowableAssociationsSlider: false,
    structuralAttachmentAssociationsSettings: {
      arrowsToggle: false,
      capSelect: false,
      colorPicker: true,
      stylePicker: true,
      widthInput: true
    }
   }
});