NamedTraceConfiguration | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

NamedTraceConfiguration Constructor 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

Type	Summary	Class
Date	The date/time when the trace configuration has been added to the utility network.	NamedTraceConfiguration
String	The portal user who created the trace configuration.	NamedTraceConfiguration
String	Short description of what kind of trace this trace configuration performs.	NamedTraceConfiguration
String	The `globalId` (UUID) uniquely identifies a trace configuration.	NamedTraceConfiguration
String	The minimum number of starting points required to perform a trace with this particular trace configuration.	NamedTraceConfiguration
Object []	The result types of the trace configuration.	NamedTraceConfiguration
String []	Labels that help identify and search for a particular trace configuration.	NamedTraceConfiguration
String	The title or the name of the trace configuration.	NamedTraceConfiguration
TraceConfiguration\|UNTraceConfiguration	The full definition of the trace configuration.	NamedTraceConfiguration
String	The trace type defined in this trace configuration.	NamedTraceConfiguration

Property Details

creationDate Property 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 Property 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 Property description String

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

globalId Property 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 Property 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 Property 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 Property tags String[]

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

title Property title String

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

traceConfiguration Property traceConfiguration TraceConfiguration |UNTraceConfiguration

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

traceType Property traceType String

The trace type defined in this trace configuration.