TraceParameters

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

The list of parameters that are needed to determine how the trace analytic will be executed. This includes trace locations, type, trace configurations, result types, output, and many other parameters.

See also:

Constructors

new TraceParameters(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The geodatabase version to execute the function against.

more detailsTraceParameters
datemore details

The date/timestamp (in UTC) to execute the function at a given time.

more detailsTraceParameters
Stringmore details

The globalId (UUID) of the named trace configuration persisted in the network.

more detailsTraceParameters
SpatialReferencemore details

The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).

more detailsTraceParameters
Object[]more detailsmore detailsTraceParameters
TraceConfigurationmore details

Defines the properties of a trace.

more detailsTraceParameters
TraceLocation[]more details

The list of starting points and barriers that will define where the trace starts and stops.

more detailsTraceParameters
Stringmore details

The trace type defined in this trace configuration.

more detailsTraceParameters

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

gdbVersion String

The geodatabase version to execute the function against. Defaults to SDE.DEFAULT when no version is provided.

moment date

The date/timestamp (in UTC) to execute the function at a given time. This could be used to run the function in a moment in the past or in long transaction mode (undo/redo). Applicable to branch versioned datasets only.

See also:
namedTraceConfigurationGlobalId String

The globalId (UUID) of the named trace configuration persisted in the network.

outSpatialReference SpatialReference

The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).

resultTypes Object[]
traceConfiguration TraceConfiguration

Defines the properties of a trace.

traceLocations TraceLocation[]

The list of starting points and barriers that will define where the trace starts and stops. This parameter can be optional (defaults to empty array) if minStartingPoints in NamedTraceConfiguration is set to none.

traceType String

The trace type defined in this trace configuration.

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

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsTraceParameters
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsTraceParameters

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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