UtilityNetworkTrace

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

The UtilityNetworkTrace widget provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view. Alternatively, the widget allows setting input flags programmatically on creation, or at runtime, by setting the flags property. The widget can execute one or multiple traces concurrently by selecting them from the trace types dropdown. Trace types can be preset in the widget programmatically on creation, or at runtime, by setting the selectedTraces property. tracetypes_flags

The trace results are returned as a selection or as graphics, or both (if aggregated geometry is set as a Result Type). result_select

The resulting selection of features can be visualized in a list organized by asset groups and asset types if the showSelectionAttributes property is true.

results_panels In the image above, the left image displays a list of trace results filtered by asset group. The center image displays a list of asset types for the asset group "Service Connection". The right image displays a list of features for the asset type "Residential".

Notes

  • Requires a WebMap published with a Utility Network and shared named trace configurations (Available at Enterprise 10.9).
  • The network topology must be enabled and the results of a trace are not guaranteed to be accurate if dirty areas are traced. The network topology for the area to be traced must be validated to reflect the most recent edits or updates made to the network.
  • Running traces on map services is not supported.
For information about gaining full control of widget styles, see the Styling topic.
See also
Example
// Create a new instance of the UtilityNetworkTrace widget and set
// its required parameters.
const unTraceWidget = new UtilityNetworkTrace({
  view: view
});

view.ui.add(unTraceWidget, "top-right");

Constructors

UtilityNetworkTrace

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

The ID or node representing the DOM element containing the widget.

Widget

The name of the class.

Accessor

The default color to assign the aggregated geometry of a trace result.

UtilityNetworkTrace

When true, the widget is visually withdrawn and cannot be interacted with.

UtilityNetworkTrace

When true, provides the ability to show the convex hull or buffer.

UtilityNetworkTrace

An array of map points to load into the widget to lookup flags.

UtilityNetworkTrace

The Geodatabase version to pass into the trace.

UtilityNetworkTrace

Icon displayed in the widget's button.

UtilityNetworkTrace

The unique ID assigned to the widget when the widget is created.

Widget

Custom labels, descriptions, and symbol for the input flags.

UtilityNetworkTrace

The widget's default label.

UtilityNetworkTrace

The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes.

UtilityNetworkTrace

A list of global Ids of traces to select on load

UtilityNetworkTrace

When true, the utility network elements are selected in the view when traces are completed.

UtilityNetworkTrace

When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed.

UtilityNetworkTrace

Determines whether to show list of selection attributes

UtilityNetworkTrace

Determines the utility network to use.

UtilityNetworkTrace

The view from which the widget will operate.

UtilityNetworkTrace

The view model for this widget.

UtilityNetworkTrace

Indicates whether the widget is visible.

Widget

Property Details

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.

defaultGraphicColor

Property
defaultGraphicColor GraphicColor
Since: ArcGIS Maps SDK for JavaScript 4.23 UtilityNetworkTrace since 4.22, defaultGraphicColor added at 4.23.

The default color to assign the aggregated geometry of a trace result.

Default Value:{ color: [255, 255, 0, 0.6], haloOpacity: 0.9, fillOpacity: 0.2, hex: "#FFFF00" }

disabled

Property
disabled Boolean

When true, the widget is visually withdrawn and cannot be interacted with.

Default Value:true

enableResultArea

Property
enableResultArea Boolean
Since: ArcGIS Maps SDK for JavaScript 4.27 UtilityNetworkTrace since 4.22, enableResultArea added at 4.27.

When true, provides the ability to show the convex hull or buffer.

Default Value:false

flags

Property
flags FlagProperty[]

An array of map points to load into the widget to lookup flags.

Default Value:[]
Example
const unt = new UtilityNetworkTrace({
 view: view,
 showSelectionAttributes: true,
 selectOnComplete: true,
 showGraphicsOnComplete: true,
 selectedTraces: ["{E8D545B8-596D-4656-BF5E-16C1D7CBEC9B}"],
 flags: [
   {
     type: "starting-point",
     mapPoint: {
       spatialReference: { latestWkid: 3857, wkid: 102100 },
       x: -9814829.166046409,
       y: 5127094.1017433
     }
   },
   {
     type: "barrier",
     mapPoint: {
     spatialReference: { latestWkid: 3857, wkid: 102100 },
       x: -9814828.449441982,
       y: 5127089.085566963
     }
   }
 ]
});

gdbVersion

Property
gdbVersion String

The Geodatabase version to pass into the trace.

Default Value:"sde.DEFAULT"

icon

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

Icon displayed in the widget's button.

Default Value:"utility-network-trace"
See also

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.

inputSettings

Property
inputSettings InputSetting[]
Since: ArcGIS Maps SDK for JavaScript 4.23 UtilityNetworkTrace since 4.22, inputSettings added at 4.23.

Custom labels, descriptions, and symbol for the input flags.

Default Value:[]

label

Property
label String

The widget's default label.

resultAreaProperties

Property
resultAreaProperties ResultAreaPropertiesExtend
Since: ArcGIS Maps SDK for JavaScript 4.27 UtilityNetworkTrace since 4.22, resultAreaProperties added at 4.27.

The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes.

Default Value:{ type: "convexhull", distance: 10, unit: "meters", areaUnit: "square-meters", color: { color: [255, 165, 0, 0.5], haloOpacity: 0.9, fillOpacity: 0.2, hex: "#ffa500" }, show: false }
Example
const unt = new UtilityNetworkTrace({
 un: un,
 view: view,
 enableResultArea: true,
 resultAreaProperties: {
   type: "buffer",
   distance: 10,
   unit: "feet",
   areaUnit: "square-feet",
   color: {
     color: [255, 165, 0, 0.5],
     haloOpacity: 0.9,
     fillOpacity: 0.2,
     hex: "#ffa500"
   },
   show: true
 }
});

selectedTraces

Property
selectedTraces String[]

A list of global Ids of traces to select on load

Default Value:[]
Example
const unt = new UtilityNetworkTrace({
 view: view,
 selectedTraces: ["{E8D545B8-596D-4656-BF5E-16C1D7CBEC9B}"]
});

selectOnComplete

Property
selectOnComplete Boolean

When true, the utility network elements are selected in the view when traces are completed.

Default Value:true

showGraphicsOnComplete

Property
showGraphicsOnComplete Boolean

When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed.

Default Value:true

showSelectionAttributes

Property
showSelectionAttributes Boolean

Determines whether to show list of selection attributes

Default Value:true

utilityNetwork

Property
utilityNetwork UtilityNetwork
Since: ArcGIS Maps SDK for JavaScript 4.27 UtilityNetworkTrace since 4.22, utilityNetwork added at 4.27.

Determines the utility network to use.

view

Property
view MapView

The view from which the widget will operate.

viewModel

Property
viewModel UtilityNetworkTraceViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the UtilityNetworkTraceViewModel class to access all properties and methods on the 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;

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

Checks if the requirements to execute a trace are met.

UtilityNetworkTrace

A utility method used for building the value for a widget's class property.

Widget

Prompts to clear all input flags, selected trace types, and the trace results.

UtilityNetworkTrace

Destroys the widget instance.

Widget

Emits an event on the instance.

Widget

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

Widget

Returns true if a named group of handles exist.

Accessor

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Widget

isRejected() may be used to verify if creating an instance of the class is rejected.

Widget

isResolved() may be used to verify if creating an instance of the class is resolved.

Widget

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

This method is implemented by subclasses for rendering.

Widget

Renders widget to the DOM immediately.

Widget

Schedules widget rendering.

Widget

when() may be leveraged once an instance of the class is created.

Widget

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.

checkCanTrace

Method
checkCanTrace(){Promise<void>}

Checks if the requirements to execute a trace are met. Returns an error if any of the requirements are not met.

Returns
Type Description
Promise<void> When resolved, an error is returned if requirements are not met to execute a trace.

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

confirmReset

Method
confirmReset()

Prompts to clear all input flags, selected trace types, and the trace results.

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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

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
Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24.
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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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

InputSetting

Type Definition
InputSetting Object

InputSetting represents the labels, descriptions, and symbols that can be overridden for the flags user interface (UI) in the UtilityNetworkTrace widget.

Properties
type String

The flag type indicates which section will have its settings overridden.

Possible Values:"starting-point"|"barrier"

label String

The label that replaces either the default "Starting points" or "Barriers" headings depending on what flag type is passed.

description String

The description that replaces the default sub-headings for either the starting points or barriers.

The symbol displayed next to either the "Starting points" or "Barriers" headings.

Example
// Set inputSettings with a SimpleMarkerSymbol
utilityNetworkTrace.inputSettings = [
  {
    type: "starting-point",
    label: "Start locations",
    description: "Add starting locations before running a trace!",
    symbol: {
      type: "simple-marker",
      style: "cross",
      color: "blue",
      size: "8px",
      outline: {
        color: [ 255, 255, 0 ],
        width: 3
      }
    }
  }
]

Event Overview

Name Type Summary Class
{type: "starting-point"|"barrier"}

Fires when the button to add either a starting point or barrier is clicked.

UtilityNetworkTrace
{type: "starting-point"|"barrier",symbol: SimpleMarkerSymbol|PictureMarkerSymbol}

Fires when a flag point graphic is added to the map.

UtilityNetworkTrace
{type: "starting-point"|"barrier",symbol: SimpleMarkerSymbol|PictureMarkerSymbol}

Fires when adding a flag point graphic to the map fails.

UtilityNetworkTrace
{graphic: Graphic}

Fires when adding a result area graphic to the map.

UtilityNetworkTrace
{graphic: Graphic}

Fires after a trace when enableResultArea is true.

UtilityNetworkTrace
{graphic: Graphic}

Fires when removing a result area graphic from the map.

UtilityNetworkTrace

Event Details

add-flag

Event
add-flag
Since: ArcGIS Maps SDK for JavaScript 4.23 UtilityNetworkTrace since 4.22, add-flag added at 4.23.

Fires when the button to add either a starting point or barrier is clicked.

Property
type String

The type of flag added.

Possible Values:"starting-point"|"barrier"

add-flag-complete

Event
add-flag-complete
Since: ArcGIS Maps SDK for JavaScript 4.23 UtilityNetworkTrace since 4.22, add-flag-complete added at 4.23.

Fires when a flag point graphic is added to the map.

Properties
type String

The type of flag added.

Possible Values:"starting-point"|"barrier"

The symbol of the flag point graphic.

add-flag-error

Event
add-flag-error
Since: ArcGIS Maps SDK for JavaScript 4.23 UtilityNetworkTrace since 4.22, add-flag-error added at 4.23.

Fires when adding a flag point graphic to the map fails.

Properties
type String

The type of flag added.

Possible Values:"starting-point"|"barrier"

The symbol of the flag point graphic.

add-result-area

Event
add-result-area
Since: ArcGIS Maps SDK for JavaScript 4.28 UtilityNetworkTrace since 4.22, add-result-area added at 4.28.

Fires when adding a result area graphic to the map.

Property
graphic Graphic

The graphic of the result area generated from the trace.

create-result-area

Event
create-result-area
Since: ArcGIS Maps SDK for JavaScript 4.29 UtilityNetworkTrace since 4.22, create-result-area added at 4.29.

Fires after a trace when enableResultArea is true.

Property
graphic Graphic

The graphic of the result area generated from the trace if enableResultArea is true.

remove-result-area

Event
remove-result-area
Since: ArcGIS Maps SDK for JavaScript 4.28 UtilityNetworkTrace since 4.22, remove-result-area added at 4.28.

Fires when removing a result area graphic from the map.

Property
graphic Graphic

The removed graphic of the result area generated from the trace.

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