TraceResult

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

This class defines the collection of results returned from the trace function. The trace can return network elements, aggregated geometries, and functions.

See also:

Constructors

new TraceResult(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
AggregatedGeometrymore details

This property defines an aggregation of geometries returned by the trace.

more detailsTraceResult
Stringmore details

The name of the class.

more detailsAccessor
NetworkElement[]more details

An array of network elements returned by the trace.

more detailsTraceResult
FunctionResult[]more details

Returns an array of function aggregation results.

more detailsTraceResult
Booleanmore details

This parameter is specific to the K-Nearest Neighbors Algorithm, when the neariest filter is provided in the trace configuration.

more detailsTraceResult
Booleanmore details

Returns true if the starting points in the network trace operation are ignored.

more detailsTraceResult
String[]more details

Returns any warnings encountered by the trace operation.

more detailsTraceResult

Property Details

aggregatedGeometry AggregatedGeometry

This property defines an aggregation of geometries returned by the trace. The aggregated geometries will only include geometries that belong to features with assetgroups/assettypes specified in the trace output. This is returned only if the aggregated geometries results type is defined in the trace configuration.

declaredClass Stringreadonly inherited

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

elements NetworkElement[]

An array of network elements returned by the trace. The network element is a representation of how the network topology defines its graph. This is returned only if the elements results type is defined in the trace configuration.

See also:
globalFunctionResults FunctionResult[]

Returns an array of function aggregation results.

kFeaturesForKNNFound Boolean

This parameter is specific to the K-Nearest Neighbors Algorithm, when the neariest filter is provided in the trace configuration. It returns true if any neighbors were found.

Default Value:false
startingPointsIgnored Boolean

Returns true if the starting points in the network trace operation are ignored.

Default Value:false
warnings String[]

Returns any warnings encountered by the trace operation.

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 detailsTraceResult
Objectmore details

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

more detailsTraceResult

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.