TraceResult | API Reference | ArcGIS Maps SDK for JavaScript

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

See also

trace

Constructors

TraceResult Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
AggregatedGeometry\|null\|undefined	This property defines an aggregation of geometries returned by the trace.	TraceResult
CircuitTraceResult []\|null\|undefined	An array of circuits returned by the trace.	TraceResult
String	The name of the class.	Accessor
NetworkElement []\|TelecomNetworkElement []	An array of network elements returned by the trace.	TraceResult
FunctionResult []	Returns an array of function aggregation results.	TraceResult
Boolean	This parameter is specific to the K-Nearest Neighbors Algorithm, when the nearest filter is provided in the trace configuration.	TraceResult
CircuitPath []\|null\|undefined	The paths returned by a path trace.	TraceResult
Boolean	Returns `true` if the starting points in the network trace operation are ignored.	TraceResult
String []\|null\|undefined	Returns any warnings encountered by the trace operation.	TraceResult

Property Details

aggregatedGeometry Property aggregatedGeometry AggregatedGeometry |null |undefinedreadonly

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.

circuits Property circuits CircuitTraceResult[] |null |undefinedreadonly Since: ArcGIS Maps SDK for JavaScript 4.34 TraceResult since 4.20, circuits added at 4.34. beta

An array of circuits returned by the trace. Used in the telecom domain network. This is returned only if the "circuits" result type is defined in the trace configuration.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

elements Property elements NetworkElement[] |TelecomNetworkElement[]readonly

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.

The elements property returning a TelecomNetworkElement is in beta and is reserved for future use in a telecom domain network.

See also

globalFunctionResults Property globalFunctionResults FunctionResult[]readonly

Returns an array of function aggregation results.

kFeaturesForKNNFound Property kFeaturesForKNNFound Booleanreadonly

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

Default Value:false

paths Property paths CircuitPath[] |null |undefinedreadonly Since: ArcGIS Maps SDK for JavaScript 4.34 TraceResult since 4.20, paths added at 4.34. beta

The paths returned by a path trace.

startingPointsIgnored Property startingPointsIgnored Booleanreadonly

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

Default Value:false

warnings Property warnings String[] |null |undefinedreadonly

Returns any warnings encountered by the trace operation.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	TraceResult
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	TraceResult

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

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 Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Method 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.