UtilityNetworkTrace

AMD: require(["esri/widgets/UtilityNetworkTrace"], (UtilityNetworkTrace) => { /* code goes here */ });
ESM: import UtilityNetworkTrace from "@arcgis/core/widgets/UtilityNetworkTrace";
Class: esri/widgets/UtilityNetworkTrace
Inheritance: UtilityNetworkTrace Widget Accessor
Since: ArcGIS API 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 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.

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

Known Limitations

  • Requires a WebMap published with a Utility Network and shared named trace configurations (Available at Enterprise 10.9).
  • Coded values of domains are displayed in the results tab list of selected features.
  • Date values currently display as epoch times in the results tab list of selected features.
  • 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

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
String|HTMLElementmore details

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

more detailsWidget
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

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

more detailsUtilityNetworkTrace
FlagProperty[]more details

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

more detailsUtilityNetworkTrace
Stringmore details

The Geodatabase version to pass into the trace.

more detailsUtilityNetworkTrace
Stringmore details

The widget's default CSS icon class.

more detailsUtilityNetworkTrace
Stringmore details

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

more detailsWidget
Stringmore details

The widget's default label.

more detailsUtilityNetworkTrace
String[]more details

A list of global Ids of traces to select on load

more detailsUtilityNetworkTrace
Booleanmore details

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

more detailsUtilityNetworkTrace
Booleanmore details

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

more detailsUtilityNetworkTrace
Booleanmore details

Determines whether to show list of selection attributes

more detailsUtilityNetworkTrace
MapViewmore details

The view from which the widget will operate.

more detailsUtilityNetworkTrace
UtilityNetworkTraceViewModelmore details

The view model for this widget.

more detailsUtilityNetworkTrace
Booleanmore details

Indicates whether the widget is visible.

more detailsWidget

Property Details

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

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

disabled Boolean

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

Default Value:true

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 String

The Geodatabase version to pass into the trace.

Default Value:"sde.DEFAULT"
iconClass String

The widget's default CSS icon class.

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.

label String

The widget's default label.

selectedTraces String[]

A list of global Ids of traces to select on load

Default Value:[]
selectOnComplete Boolean

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

Default Value:true
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 Boolean

Determines whether to show list of selection attributes

Default Value:true
view MapView

The view from which the widget will operate.

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

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

Checks if the requirements to execute a trace are met.

more detailsUtilityNetworkTrace
Stringmore details

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

more detailsWidget
more details

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

more detailsUtilityNetworkTrace
more details

Destroys the widget instance.

more detailsWidget
Booleanmore details

Emits an event on the instance.

more detailsWidget
Booleanmore details

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

more detailsWidget
Booleanmore details

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

more detailsWidget
Booleanmore details

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

more detailsWidget
Booleanmore details

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

more detailsWidget
Objectmore details

Registers an event handler on the instance.

more detailsWidget
more details

Widget teardown helper.

more detailsWidget
more details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
Objectmore details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
more details

Renders widget to the DOM immediately.

more detailsWidget
more details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
Promisemore details

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

more detailsWidget

Method Details

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(classNames){String}inherited

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.
See also:
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)} />
  );
}
confirmReset()

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

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

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(type){Boolean}inherited

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.
isFulfilled(){Boolean}inherited

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(){Boolean}inherited

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(){Boolean}inherited

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(type, listener){Object}inherited

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(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

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.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
Type 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(callback, errback){Promise}inherited

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 that may be used to chain additional functions.
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
});

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