import "@arcgis/map-components/components/arcgis-utility-network-trace";
Utility Network Trace 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 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 |
---|---|---|
auto-destroy-disabled | boolean | |
| ||
disabled | boolean | |
enable-result-area | boolean | |
| Array<FlagProperty> | |
gdbVersion deprecated | gdb-version | string |
icon | string | |
| Array<InputSetting> | |
label | string | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
| ||
| Array<string> | |
select-on-complete-disabled | boolean | |
show-graphics-on-complete-disabled | boolean | |
show-selection-attributes-disabled | boolean | |
state readonly | state | "loading" | "ready" |
autoDestroyDisabled
autoDestroyDisabled: 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
defaultGraphicColor: 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
disabled: boolean
When true, the widget is visually withdrawn and cannot be interacted with.
- Attribute
- disabled
- Default value
- true
enableResultArea
enableResultArea: boolean
When true
, provides the ability to show the convex hull or buffer.
- Attribute
- enable-result-area
- Default value
- false
flags
flags: Array<FlagProperty>
An array of map points to load into the widget to lookup flags.
- Default value
- []
gdbVersion
gdbVersion: string
gdbVersion
is deprecated since version 4.31.The Geodatabase version to pass into the trace.
- Attribute
- gdb-version
- Default value
- "sde.DEFAULT"
icon
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "utility-network-trace"
inputSettings
inputSettings: Array<InputSetting>
Custom labels, descriptions, and symbol for the input flags.
- Default value
- []
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
- Attribute
- position
- Default value
- "top-right"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string
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.
- Attribute
- reference-element
resultAreaProperties
resultAreaProperties: 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 }
selectedTraces
selectedTraces: Array<string>
A list of global Ids of traces to select on load.
- Default value
- []
selectOnCompleteDisabled
selectOnCompleteDisabled: boolean
When true, the utility network elements are selected in the view when traces are completed.
- Attribute
- select-on-complete-disabled
- Default value
- true
showGraphicsOnCompleteDisabled
showGraphicsOnCompleteDisabled: 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
- true
showSelectionAttributesDisabled
showSelectionAttributesDisabled: boolean
Determines whether to show list of selection attributes.
- Attribute
- show-selection-attributes-disabled
- Default value
- true
state
state: "loading" | "ready"
The current state of the component.
- Attribute
- state
- Default value
- "ready"
Slots
Events
Event | Type |
---|---|
UtilityNetworkTraceAddFlagEvent | |
UtilityNetworkTraceAddFlagCompleteEvent | |
UtilityNetworkTraceAddFlagErrorEvent | |
UtilityNetworkTraceAddResultAreaEvent | |
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> | |
UtilityNetworkTraceRemoveResultAreaEvent |
arcgisAddFlag
arcgisAddFlag: UtilityNetworkTraceAddFlagEvent
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.
arcgisAddFlagComplete
arcgisAddFlagComplete: UtilityNetworkTraceAddFlagCompleteEvent
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.
arcgisAddFlagError
arcgisAddFlagError: UtilityNetworkTraceAddFlagErrorEvent
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.
arcgisAddResultArea
arcgisAddResultArea: UtilityNetworkTraceAddResultAreaEvent
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.
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
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.
arcgisReady
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene 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: UtilityNetworkTraceRemoveResultAreaEvent
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.
Methods
Method | Signature |
---|---|
checkCanTrace(): Promise<void> | |
componentOnReady(): Promise<void> | |
confirmReset(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
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!");
- Returns
- Promise<void>