arcgis-utility-network-trace | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/map-components/components/arcgis-utility-network-trace";

Inheritance:: ArcgisUtilityNetworkTrace→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 4.28

This component is deprecated. arcgis-utility-network-trace-analysis is the preferred component for utility network tracing and should be used for all new development.

Utility Network Trace component provides a way to run traces in a Utility Network based on connectivity or traversability from set trace locations. Trace locations (starting points and barriers) can be set by clicking the view.

The Utility Network Trace component does not support proxied feature services or feature services that utilize stored credentials.

Note: Sign in to access the data in this sample, U/P: viewer01/I68VGU^nMurF

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`defaultGraphicColor`		`GraphicColor`
`disabled` reflected	`disabled`	`boolean`
`enableResultArea`	`enable-result-area`	`boolean`
`flags`		`Array<FlagProperty>`
`icon`	`icon`	`Icon["icon"]`
`inputSettings`		`Array<InputSetting>`
`label`	`label`	`string`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`resultAreaProperties`		`ResultAreaPropertiesExtend`
`selectedTraces`		`Array<string>`
`selectOnCompleteDisabled`	`select-on-complete-disabled`	`boolean`
`showGraphicsOnCompleteDisabled`	`show-graphics-on-complete-disabled`	`boolean`
`showSelectionAttributesDisabled`	`show-selection-attributes-disabled`	`boolean`
`state` readonly		`UtilityNetworkTraceViewModelState`
`traceResults` readonly		`TraceResultExtend[]`
`view`		`MapView \| null \| undefined`

autoDestroyDisabled

Property

Type: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy() method when you are done to prevent memory leaks.

Attribute: auto-destroy-disabled
Default value: false

defaultGraphicColor

Property

Type: GraphicColor

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

reflected Property

Type: boolean

When true, the component is visually withdrawn and cannot receive user interaction.

Attribute: disabled
Default value: false

enableResultArea

Property

Type: boolean

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

Attribute: enable-result-area
Default value: false

flags

Property

Type: Array<FlagProperty>

An array of map points to load into the component 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"]

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

Calcite Icons

Attribute: icon
Default value: "utility-network-trace"

inputSettings

Property

Type: Array<InputSetting>

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

Default value: []

label

Property

Type: string

The component's default label.

Attribute: label

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

Associate components with a Map or Scene component

Attribute: reference-element

resultAreaProperties

Property

Type: ResultAreaPropertiesExtend

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

selectOnCompleteDisabled

Property

Type: boolean

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

Attribute: select-on-complete-disabled
Default value: false

showGraphicsOnCompleteDisabled

Property

Type: boolean

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

Attribute: show-graphics-on-complete-disabled
Default value: false

showSelectionAttributesDisabled

Property

Type: boolean

Determines whether to show list of selection attributes

Attribute: show-selection-attributes-disabled
Default value: false

state

readonly Property

Type: UtilityNetworkTraceViewModelState

The current state of the component.

Default value: "ready"

traceResults

readonly Property

Type: TraceResultExtend[]

Since: ArcGIS Maps SDK for JavaScript 4.34

Stores the result of completed traces.

view

Property

Type: MapView | null | undefined

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-trace component will be associated with a map or scene component rather than using the view property.

Methods

Method	Signature
`checkCanTrace`	`checkCanTrace(): Promise<void>`
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`confirmReset`	`confirmReset(): Promise<void>`
`destroy`	`destroy(): Promise<void>`

checkCanTrace

Method

Signature: checkCanTrace (): Promise<void>

Returns: Promise<void>

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisUtilityNetworkTrace = document.querySelector("arcgis-utility-network-trace");
document.body.append(arcgisUtilityNetworkTrace);
await arcgisUtilityNetworkTrace.componentOnReady();
console.log("arcgis-utility-network-trace is ready to go!");

confirmReset

Method

Signature: confirmReset (): Promise<void>

Returns: Promise<void>

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
`arcgisAddFlag`	CustomEvent<UtilityNetworkTraceViewModelAddFlagEvent>
`arcgisAddFlagComplete`	CustomEvent<UtilityNetworkTraceViewModelAddFlagCompleteEvent>
`arcgisAddFlagError`	CustomEvent<UtilityNetworkTraceViewModelAddFlagErrorEvent>
`arcgisAddResultArea`	CustomEvent<UtilityNetworkTraceViewModelAddResultAreaEvent>
`arcgisPropertyChange`	CustomEvent<{ name: "state" \| "traceResults"; }>
`arcgisReady`	CustomEvent<void>
`arcgisRemoveResultArea`	CustomEvent<UtilityNetworkTraceViewModelRemoveResultAreaEvent>

arcgisAddFlag

Event

arcgisAddFlag: CustomEvent<UtilityNetworkTraceViewModelAddFlagEvent>

arcgisAddFlagComplete

Event

arcgisAddFlagComplete: CustomEvent<UtilityNetworkTraceViewModelAddFlagCompleteEvent>

arcgisAddFlagError

Event

arcgisAddFlagError: CustomEvent<UtilityNetworkTraceViewModelAddFlagErrorEvent>

arcgisAddResultArea

Event

arcgisAddResultArea: CustomEvent<UtilityNetworkTraceViewModelAddResultAreaEvent>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state" | "traceResults"; }>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is ready to be interacted with.

arcgisRemoveResultArea

Event

arcgisRemoveResultArea: CustomEvent<UtilityNetworkTraceViewModelRemoveResultAreaEvent>