Utility Network Trace

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

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

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

Attribute

disabled

Default value

true

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

Attribute

enable-result-area

Default value

false

An array of map points to load into the widget to lookup flags.

Default value

[]

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"

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

Default value

[]

The widget's default label.

Read more...

Attribute

label

Attribute

position

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

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 }

A list of global Ids of traces to select on load.

Default value

[]

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

Read more...

Attribute

select-on-complete-disabled

Default value

true

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

Read more...

Attribute

show-graphics-on-complete-disabled

Default value

true

Determines whether to show list of selection attributes.

Read more...

Attribute

show-selection-attributes-disabled

Default value

true

The current state of the component.

Attribute

state

Default value

"ready"

Stores the result of completed traces.

Read more...

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 Utility Network Trace component will be associated with a map or scene component rather than using the view property.

Returns

Promise<void>

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
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>

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

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

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