import NamedTraceConfiguration from "@arcgis/core/networks/support/NamedTraceConfiguration.js";const NamedTraceConfiguration = await $arcgis.import("@arcgis/core/networks/support/NamedTraceConfiguration.js");- Inheritance:
- NamedTraceConfiguration→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.20
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.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
string[] | | |
| | ||
| | ||
| |
creationDate
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.
globalId
- Type
- 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
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.
resultTypes
- Type
- ResultType[]
The result types of the trace configuration. The trace can return elements and aggregated geometries of the results. Specifies the expected trace results.
tags
- Type
- string[]
Labels that help identify and search for a particular trace configuration.
title
- Type
- string
The title or the name of the trace configuration. Trace configuration names are not unique.
traceConfiguration
- Type
- TraceConfiguration | null | undefined
The full definition of the trace configuration. Only available when fully loading a utility network.