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
| Property | Attribute | Type |
|---|---|---|
| ||
disabled | boolean | |
enable-result-area | boolean | |
| Array<FlagProperty> | |
gdb-version | string | |
| Array<InputSetting> | |
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 |
position
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
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string- Attribute
- reference-element
selectOnCompleteDisabled
selectOnCompleteDisabled: boolean- Attribute
- select-on-complete-disabled
- Default value
- false
showGraphicsOnCompleteDisabled
showGraphicsOnCompleteDisabled: boolean- Attribute
- show-graphics-on-complete-disabled
- Default value
- false
showSelectionAttributesDisabled
showSelectionAttributesDisabled: boolean- Attribute
- show-selection-attributes-disabled
- Default value
- false
Methods
| Method | Signature |
|---|---|
checkCanTrace(): Promise<void> | |
componentOnReady(): Promise<void> | |
confirmReset(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
UtilityNetworkTraceAddFlagEvent | |
UtilityNetworkTraceAddFlagCompleteEvent | |
UtilityNetworkTraceAddFlagErrorEvent | |
UtilityNetworkTraceAddResultAreaEvent | |
undefined | |
UtilityNetworkTraceRemoveResultAreaEvent |
arcgisAddFlag
arcgisAddFlag: UtilityNetworkTraceAddFlagEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisAddFlagComplete
arcgisAddFlagComplete: UtilityNetworkTraceAddFlagCompleteEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisAddFlagError
arcgisAddFlagError: UtilityNetworkTraceAddFlagErrorEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisAddResultArea
arcgisAddResultArea: UtilityNetworkTraceAddResultAreaEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: undefinedEmitted when the component associated with a map view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisRemoveResultArea
arcgisRemoveResultArea: UtilityNetworkTraceRemoveResultAreaEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.