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
AggregatedGeometry

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

more details
TraceResult
String

The name of the class.

more details
Accessor
NetworkElement[]

An array of network elements returned by the trace.

more details
TraceResult
FunctionResult[]

Returns an array of function aggregation results.

more details
TraceResult
Boolean

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

more details
TraceResult
Boolean

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

more details
TraceResult
String[]

Returns any warnings encountered by the trace operation.

more details
TraceResult

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

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

more details
TraceResult
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
TraceResult

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.