require(["esri/networks/support/NamedTraceConfiguration"], (NamedTraceConfiguration) => { /* code goes here */ });
import NamedTraceConfiguration from "@arcgis/core/networks/support/NamedTraceConfiguration.js";
esri/networks/support/NamedTraceConfiguration
This class describes a trace configuration object. It contains the necessary properties used to perform a trace, and identifies what the trace should return. Trace configurations can be shared across an organization through a webmap during publishing, and are part of the webmap spec. Named trace configurations improve the user experience associated with tracing, since it allows users to run pre-configured traces without needing to understand every configuration detail. Trace configurations can be added using the Add Trace Configuration gp tool or the REST end point.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The date/time when the trace configuration has been added to the utility network. | NamedTraceConfiguration | ||
The portal user who created the trace configuration. | NamedTraceConfiguration | ||
Short description of what kind of trace this trace configuration performs. | NamedTraceConfiguration | ||
The | NamedTraceConfiguration | ||
The minimum number of starting points required to perform a trace with this particular trace configuration. | NamedTraceConfiguration | ||
The result types of the trace configuration. | NamedTraceConfiguration | ||
Labels that help identify and search for a particular trace configuration. | NamedTraceConfiguration | ||
The title or the name of the trace configuration. | NamedTraceConfiguration | ||
The full definition of the trace configuration. | NamedTraceConfiguration | ||
The trace type defined in this trace configuration. | NamedTraceConfiguration |
Property Details
-
The date/time when the trace configuration has been added to the utility network. Trace configurations can be added using the Add Trace configuration gp tool or the REST end point gp tool or the REST end point.
-
The portal user who created the trace configuration. Trace configurations can be added using the
Add Trace configurationgp tool or the REST end point.
-
Short description of what kind of trace this trace configuration performs.
-
globalId
PropertyglobalId String -
The
globalId(UUID) uniquely identifies a trace configuration. Users can pass this id to a trace to reference the trace configuration to be used by the trace.
-
The minimum number of starting points required to perform a trace with this particular trace configuration. Some trace configurations (
e.g. Subnetwork) does not require any starting points because the persisted subnetwork name is used to determine the starting locations. This property can be used to derive a user experience, for instance, hide or show the starting location control ifminStartingPointsisnone.Possible Values:"none" |"one" |"many"
-
The result types of the trace configuration. The trace can return elements and aggregated geometries of the results. Specifies the expected trace results.
-
Labels that help identify and search for a particular trace configuration.
-
title
Propertytitle String -
The title or the name of the trace configuration. Trace configuration names are not unique.
-
traceConfiguration
PropertytraceConfiguration TraceConfiguration |UNTraceConfiguration |null |undefinedautocast -
The full definition of the trace configuration. Only available when fully loading a utility network.