require(["esri/rest/networks/support/TraceResult"], (TraceResult) => { /* code goes here */ });
import TraceResult from "@arcgis/core/rest/networks/support/TraceResult.js";
esri/rest/networks/support/TraceResult
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| AggregatedGeometry | This property defines an aggregation of geometries returned by the trace. | TraceResult | |
| String | The name of the class. | Accessor | |
| NetworkElement[] | 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 neariest filter is provided in the trace configuration. | TraceResult | |
| Boolean | Returns | TraceResult | |
| String[] | Returns any warnings encountered by the trace operation. | TraceResult |
Property Details
-
aggregatedGeometry
PropertyaggregatedGeometry 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/assettypesspecified in the trace output. This is returned only if the aggregated geometries results type is defined in the trace configuration.
-
elements
Propertyelements 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
PropertyglobalFunctionResults FunctionResult[] -
Returns an array of function aggregation results.
-
kFeaturesForKNNFound
PropertykFeaturesForKNNFound Boolean -
This parameter is specific to the K-Nearest Neighbors Algorithm, when the neariest filter is provided in the trace configuration. It returns
trueif any neighbors were found.- Default Value:false
-
startingPointsIgnored
PropertystartingPointsIgnored Boolean -
Returns
trueif the starting points in the network trace operation are ignored.- Default Value:false
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | 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
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.