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.
The trace results are returned as a selection or as graphics, or both (if aggregated geometry is set as a Result Type).
The resulting selection of features can be visualized in a list organized by asset groups and asset types if the showSelectionAttributes property is true
.
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.
- The Utility Network feature service must be secured since the ArcGIS Utility Network user type extension is required for users who wish to run a trace on the web service.
- Running traces on map services is not supported.
- See also
// 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)
-
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 |
---|---|---|---|
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 | |
GraphicColor | The default color to assign the aggregated geometry of a trace result. more details | UtilityNetworkTrace | |
Boolean | When true, the widget is visually withdrawn and cannot be interacted with. more details | UtilityNetworkTrace | |
FlagProperty[] | An array of map points to load into the widget to lookup flags. more details | UtilityNetworkTrace | |
String | The Geodatabase version to pass into the trace. more details | UtilityNetworkTrace | |
String | The widget's default CSS icon class. more details | UtilityNetworkTrace | |
String | The unique ID assigned to the widget when the widget is created. more details | Widget | |
InputSetting[] | Custom labels, descriptions, and symbol for the input flags. more details | UtilityNetworkTrace | |
String | The widget's default label. more details | UtilityNetworkTrace | |
String[] | A list of global Ids of traces to select on load more details | UtilityNetworkTrace | |
Boolean | When true, the utility network elements are selected in the view when traces are completed. more details | UtilityNetworkTrace | |
Boolean | When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. more details | UtilityNetworkTrace | |
Boolean | Determines whether to show list of selection attributes more details | UtilityNetworkTrace | |
MapView | The view from which the widget will operate. more details | UtilityNetworkTrace | |
UtilityNetworkTraceViewModel | The view model for this widget. more details | UtilityNetworkTrace | |
Boolean | Indicates whether the widget is visible. more details | Widget |
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" });
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
defaultGraphicColor GraphicColorSince: ArcGIS Maps SDK for JavaScript 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 Boolean
-
When true, the widget is visually withdrawn and cannot be interacted with.
- Default Value:true
-
flags FlagProperty[]
-
An array of map points to load into the widget to lookup flags.
- Default Value:[]
Exampleconst 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.
-
inputSettings InputSetting[]Since: ArcGIS Maps SDK for JavaScript 4.23
-
Custom labels, descriptions, and symbol for the input flags.
- Default Value:[]
-
label String
-
The widget's default label.
-
A list of global Ids of traces to select on load
- Default Value:[]
Exampleconst unt = new UtilityNetworkTrace({ view: view, selectedTraces: ["{E8D545B8-596D-4656-BF5E-16C1D7CBEC9B}"] });
-
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.
-
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.
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Promise<void> | Checks if the requirements to execute a trace are met. more details | UtilityNetworkTrace | |
String | A utility method used for building the value for a widget's | Widget | |
Prompts to clear all input flags, selected trace types, and the trace results. more details | UtilityNetworkTrace | ||
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)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
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.
-
checkCanTrace(){Promise<void>}
-
Checks if the requirements to execute a trace are met. Returns an error if any of the requirements are not met.
ReturnsType Description Promise<void> When resolved, an error is returned if requirements are not met to execute a trace.
-
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)} /> ); }
-
confirmReset()
-
Prompts to clear all input flags, selected trace types, and the trace results.
-
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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.24
-
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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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
-
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 StringThe label that replaces either the default "Starting points" or "Barriers" headings depending on what flag type is passed.
description StringThe 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. more details |
UtilityNetworkTrace | |
{type: "starting-point"|"barrier",symbol: SimpleMarkerSymbol|PictureMarkerSymbol} |
Fires when a flag point graphic is added to the map. more details |
UtilityNetworkTrace | |
{type: "starting-point"|"barrier",symbol: SimpleMarkerSymbol|PictureMarkerSymbol} |
Fires when adding a flag point graphic to the map fails. more details |
UtilityNetworkTrace |
Event Details
-
add-flagSince: ArcGIS Maps SDK for JavaScript 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-completeSince: ArcGIS Maps SDK for JavaScript 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-errorSince: ArcGIS Maps SDK for JavaScript 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.