UtilityNetworkTrace | References | ArcGIS Maps SDK for JavaScript

import UtilityNetworkTrace from "@arcgis/core/widgets/UtilityNetworkTrace.js";

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 Point". The right image displays a list of features for the asset type "Single Phase Low Voltage Meter".

Nonspatial data can be included as trace starting points and barriers. Additionally, users can examine nonspatial data within the trace results.

nonspatial_add

Notes

The UtilityNetworkTrace widget class is unable to support proxied feature services or feature services that utilize stored credentials. 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. Support for adding nonspatial features as trace locations and displaying Utility Network Associations info in the trace result require using a WebMap with popups including UtilityNetworkAssociationsContent. Updating the map property in the View does not automatically refresh the contents of the UtilityNetworkTrace widget.

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`UtilityNetworkTraceProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`container` inherited	`HTMLElement \| null \| undefined`	Widget
`declaredClass` readonly inherited	`string`	Accessor
`defaultGraphicColor`	`GraphicColor`
`destroyed` readonly inherited	`boolean`	Widget
`disabled`	`boolean`
`enableResultArea`	`boolean`
`flags`	`FlagProperty[]`
`icon`	`Icon["icon"]`
`id` inherited	`string`	Widget
`inputSettings`	`InputSetting[]`
`label`	`string`
`resultAreaProperties`	`ResultAreaPropertiesExtend`
`selectedTraces`	`string[]`
`selectOnComplete`	`boolean`
`showGraphicsOnComplete`	`boolean`
`showSelectionAttributes`	`boolean`
`traceResults` readonly	`Array<TraceResultExtend>`
`utilityNetwork`	`UtilityNetwork \| null \| undefined`
`view`	`MapView \| null \| undefined`
`viewModel`	`UtilityNetworkTraceViewModel`
`visible` inherited	`boolean`	Widget

container

autocast inherited Property

Type: HTMLElement | null | undefined

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

readonlyinherited Property

Type: string

Inherited from: Accessor

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

defaultGraphicColor

Property

Type: GraphicColor

Since: 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" }

destroyed

readonlyinherited Property

Type: boolean

Inherited from: Widget

When true, this property indicates whether the widget has been destroyed.

disabled

Property

Type: boolean

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

Default value: true

enableResultArea

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.27

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

Default value: false

flags

Property

Type: 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
     }
   }
 ]
});

icon

autocast Property

Type: Icon["icon"]

Since: ArcGIS Maps SDK for JavaScript 4.27

Icon displayed in the widget's button.

See also

Default value: "utility-network-trace"

id

inherited Property

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

Type: InputSetting[]

Since: ArcGIS Maps SDK for JavaScript 4.23

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

Default value: []

label

autocast Property

Type: string

The widget's default label.

resultAreaProperties

Property

Type: ResultAreaPropertiesExtend

Since: ArcGIS Maps SDK for JavaScript 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

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

Type: boolean

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

Default value: true

showGraphicsOnComplete

Property

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

Type: boolean

Determines whether to show list of selection attributes

Default value: true

traceResults

readonly Property

Type: Array<TraceResultExtend>

Since: ArcGIS Maps SDK for JavaScript 4.34

Stores the result of completed traces.

utilityNetwork

Property

Type: UtilityNetwork | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

Determines the utility network to use.

view

Property

Type: MapView | null | undefined

The view from which the widget will operate.

viewModel

autocast Property

Type: UtilityNetworkTraceViewModel

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

Type: 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 DefaultUI, 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;

Methods

Method	Signature	Class
`checkCanTrace`	`checkCanTrace(): Promise<void>`
`classes` inherited	`classes(...classNames: ((string \| null \| undefined) \| ((string[] \| Record<string, boolean>) \| null \| undefined) \| false \| null \| undefined)[]): string`	Widget
`confirmReset`	`confirmReset(): void`
`destroy` inherited	`destroy(): void`	Widget
`emit` inherited	`emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean`	EventedMixin
`hasEventListener` inherited	`hasEventListener<Type extends EventNames<this>>(type: Type): boolean`	EventedMixin
`isFulfilled` inherited	`isFulfilled(): boolean`	EsriPromiseMixin
`isRejected` inherited	`isRejected(): boolean`	EsriPromiseMixin
`isResolved` inherited	`isResolved(): boolean`	EsriPromiseMixin
`on` inherited	`on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle`	EventedMixin
`postInitialize` inherited	`postInitialize(): void`	Widget
`render` inherited	`render(): any \| null`	Widget
`renderNow` inherited	`renderNow(): void`	Widget
`scheduleRender` inherited	`scheduleRender(): void`	Widget
`when` inherited	`when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>`	EsriPromiseMixin

checkCanTrace

Method

Signature: 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: Promise<void>
When resolved, an error is returned if requirements are not met to execute a trace.

classes

inherited Method

Signature: classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): 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.

Parameters

Parameter	Type	Description	Required
classNames	`((string \| null \| undefined) \| ((string[] \| Record<string, boolean>) \| null \| undefined) \| false \| null \| undefined)[]`	The class names.

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

Signature: confirmReset (): void

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

Returns: void

destroy

inherited Method

Signature: destroy (): void

Inherited from: Widget

Destroys the widget instance.

Returns: void

emit

inherited Method

Signature: emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

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

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.
event	`this["@eventTypes"][Type]`	The event payload.

Returns: boolean
true if a listener was notified

hasEventListener

inherited Method

Signature: hasEventListener <Type extends EventNames<this>>(type: Type): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

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

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.

Returns: boolean
Returns true if the class supports the input event.

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

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: boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

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

Returns: boolean
Indicates whether creating an instance of the class has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

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

Returns: boolean
Indicates whether creating an instance of the class has been resolved.

on

inherited Method

Signature: on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

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

Parameters

Parameter	Type	Description	Required
type	`Type`	An event or an array of events to listen for.
listener	`EventedCallback<this["@eventTypes"][Type]>`	The function to call when the event fires.

Returns

ResourceHandle

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

postInitialize

inherited Method

Signature: postInitialize (): void

Inherited from: Widget

Executes after widget is ready for rendering.

Returns: void

render

inherited Method

Signature: render (): any | null

Inherited from: Widget

This method is implemented by subclasses for rendering.

Returns: any | null
The rendered virtual node.

renderNow

inherited Method

Signature: renderNow (): void

Inherited from: Widget

Renders widget to the DOM immediately.

Returns: void

scheduleRender

inherited Method

Signature: scheduleRender (): void

Inherited from: Widget

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

Returns: void

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

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

Parameters

Parameter	Type	Description	Required
onFulfilled	`OnFulfilledCallback<this, TResult1> \| null \| undefined`	The function to call when the promise resolves.
onRejected	`OnRejectedCallback \| null \| undefined`	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.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
});

Events

Name	Type
`add-flag` inherited	CustomEvent<UtilityNetworkTraceViewModelAddFlagEvent>
`add-flag-complete` inherited	CustomEvent<UtilityNetworkTraceViewModelAddFlagCompleteEvent>
`add-flag-error` inherited	CustomEvent<UtilityNetworkTraceViewModelAddFlagErrorEvent>
`add-result-area` inherited	CustomEvent<UtilityNetworkTraceViewModelAddResultAreaEvent>
`create-result-area` inherited	CustomEvent<UtilityNetworkTraceViewModelCreateResultAreaEvent>
`remove-result-area` inherited	CustomEvent<UtilityNetworkTraceViewModelRemoveResultAreaEvent>

add-flag

inherited Event

add-flag: CustomEvent<UtilityNetworkTraceViewModelAddFlagEvent>

Inherited from: UtilityNetworkTraceViewModelEvents

Since: ArcGIS Maps SDK for JavaScript 4.23

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

add-flag-complete

inherited Event

add-flag-complete: CustomEvent<UtilityNetworkTraceViewModelAddFlagCompleteEvent>

Inherited from: UtilityNetworkTraceViewModelEvents

Since: ArcGIS Maps SDK for JavaScript 4.23

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

add-flag-error

inherited Event

add-flag-error: CustomEvent<UtilityNetworkTraceViewModelAddFlagErrorEvent>

Inherited from: UtilityNetworkTraceViewModelEvents

Since: ArcGIS Maps SDK for JavaScript 4.23

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

add-result-area

inherited Event

add-result-area: CustomEvent<UtilityNetworkTraceViewModelAddResultAreaEvent>

Inherited from: UtilityNetworkTraceViewModelEvents

Since: ArcGIS Maps SDK for JavaScript 4.28

Fires when adding a result area graphic to the map.

create-result-area

inherited Event

create-result-area: CustomEvent<UtilityNetworkTraceViewModelCreateResultAreaEvent>

Inherited from: UtilityNetworkTraceViewModelEvents

Since: ArcGIS Maps SDK for JavaScript 4.29

Fires after a trace when UtilityNetworkTrace.enableResultArea is true.

remove-result-area

inherited Event

remove-result-area: CustomEvent<UtilityNetworkTraceViewModelRemoveResultAreaEvent>

Inherited from: UtilityNetworkTraceViewModelEvents

Since: ArcGIS Maps SDK for JavaScript 4.28

Fires when removing a result area graphic from the map.

Type definitions

InputSetting

Type definition

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

type

Property

Type: string

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

label

Property

Type: string

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

description

Property

Type: string

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

symbol

Property

Type: SimpleMarkerSymbol | PictureMarkerSymbol | undefined

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