NamedTraceConfiguration

AMD: require(["esri/networks/support/NamedTraceConfiguration"], (NamedTraceConfiguration) => { /* code goes here */ });
ESM: import NamedTraceConfiguration from "@arcgis/core/networks/support/NamedTraceConfiguration";
Class: esri/networks/support/NamedTraceConfiguration
Since: ArcGIS API for JavaScript 4.20

This class describes a trace configuration object. It contains the neccessary 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

new NamedTraceConfiguration(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Name Type Summary Class
Datemore details

The date/time when the trace configuration has been added to the utility network.

more detailsNamedTraceConfiguration
Stringmore details

The portal user who created the trace configuration.

more detailsNamedTraceConfiguration
Stringmore details

Short description of what kind of trace this trace configuration performs.

more detailsNamedTraceConfiguration
Stringmore details

The globalId (UUID) uniquely identifies a trace configuration.

more detailsNamedTraceConfiguration
Stringmore details

The minimum number of starting points required to perform a trace with this particular trace configuration.

more detailsNamedTraceConfiguration
Object[]more details

The result types of the trace configuration.

more detailsNamedTraceConfiguration
String[]more details

Labels that help identify and search for a particular trace configuration.

more detailsNamedTraceConfiguration
Stringmore details

The title or the name of the trace configuration.

more detailsNamedTraceConfiguration
TraceConfiguration|UNTraceConfigurationmore details

The full definition of the trace configuration.

more detailsNamedTraceConfiguration
Stringmore details

The trace type defined in this trace configuration.

more detailsNamedTraceConfiguration

Property Details

creationDate Date

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.

creator String

The portal user who created the trace configuration. Trace configurations can be added using the Add Trace configuration gp tool or the REST end point.

description String

Short description of what kind of trace this trace configuration performs.

globalId 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.

minStartingPoints String

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 if minStartingPoints is none.

Possible Values:"none"|"one"|"many"

resultTypes Object[]

The result types of the trace configuration. The trace can return elements and aggregated geometries of the results. Specifies the expected trace results.

tags String[]

Labels that help identify and search for a particular trace configuration.

title String

The title or the name of the trace configuration. Trace configuration names are not unique.

traceConfiguration TraceConfiguration|UNTraceConfiguration

The full definition of the trace configuration. Only available when fully loading a utility network.

traceType String

The trace type defined in this trace configuration.

Possible Values:"connected"|"upstream"|"downstream"|"shortest-path"|"subnetwork"|"subnetwork-controllers"|"loops"|"isolation"

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