Utility Network Trace

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

UtilityNetworkTrace component 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.

The UtilityNetworkTrace 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

PropertyAttributeType
disabled
boolean
enable-result-area
boolean
gdb-version
string
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Array<string>
select-on-complete-disabled
boolean
show-graphics-on-complete-disabled
boolean
show-selection-attributes-disabled
boolean

defaultGraphicColor

Property
defaultGraphicColor: GraphicColor

disabled

Property
disabled: boolean
Attribute
disabled
Default value
false

enableResultArea

Property
enableResultArea: boolean
Attribute
enable-result-area
Default value
false

flags

Property
flags: Array<FlagProperty>

gdbVersion

Property
gdbVersion: string
Attribute
gdb-version
Default value
"sde.DEFAULT"

inputSettings

Property
inputSettings: Array<InputSetting>

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

resultAreaProperties

Property
resultAreaProperties: ResultAreaPropertiesExtend

selectedTraces

Property
selectedTraces: Array<string>

selectOnCompleteDisabled

Property
selectOnCompleteDisabled: boolean
Attribute
select-on-complete-disabled
Default value
false

showGraphicsOnCompleteDisabled

Property
showGraphicsOnCompleteDisabled: boolean
Attribute
show-graphics-on-complete-disabled
Default value
false

showSelectionAttributesDisabled

Property
showSelectionAttributesDisabled: boolean
Attribute
show-selection-attributes-disabled
Default value
false

Methods

MethodSignature
checkCanTrace(): Promise<void>
componentOnReady(): Promise<void>
confirmReset(): Promise<void>

checkCanTrace

Method
checkCanTrace(): Promise<void>
Returns
Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

confirmReset

Method
confirmReset(): Promise<void>
Returns
Promise<void>

Events

EventType
UtilityNetworkTraceAddFlagEvent
UtilityNetworkTraceAddFlagCompleteEvent
UtilityNetworkTraceAddFlagErrorEvent
UtilityNetworkTraceAddResultAreaEvent
undefined
UtilityNetworkTraceRemoveResultAreaEvent

arcgisAddFlag

Event
arcgisAddFlag: UtilityNetworkTraceAddFlagEvent

arcgisAddFlagComplete

Event
arcgisAddFlagComplete: UtilityNetworkTraceAddFlagCompleteEvent

arcgisAddFlagError

Event
arcgisAddFlagError: UtilityNetworkTraceAddFlagErrorEvent

arcgisAddResultArea

Event
arcgisAddResultArea: UtilityNetworkTraceAddResultAreaEvent

arcgisReady

Event
arcgisReady: undefined

arcgisRemoveResultArea

Event
arcgisRemoveResultArea: UtilityNetworkTraceRemoveResultAreaEvent

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close