require(["esri/rest/networks/support/TraceLocation"], (TraceLocation) => { /* code goes here */ });
import TraceLocation from "@arcgis/core/rest/networks/support/TraceLocation.js";
esri/rest/networks/support/TraceLocation
To perform the trace analytic, users can optionally supply a list of locations in forms of globalIds (UUID) and terminals. These locations indicate where should the trace start (also known as starting points) and where should it end (barriers) Starting locations can be applied to all network sources.
- 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 |
---|---|---|---|
The name of the class. | Accessor | ||
The globalId (UUID) of the feature to start or stop the trace. | TraceLocation | ||
This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers. | TraceLocation | ||
This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. | TraceLocation | ||
The terminal Id to place the starting location at. | TraceLocation | ||
The type of the trace location; | TraceLocation |
Property Details
-
globalId
globalId String
-
The globalId (UUID) of the feature to start or stop the trace.
-
isFilterBarrier
isFilterBarrier Boolean
-
This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers. Setting this to
false
will stop the trace if it encounters this barrier. When to set totrue
, the trace will momenterily skip the barrier to find any upstream controllers and will filter out the output accordingly. Applicable subnetwork-based trace types only.- Default Value:false
-
percentAlong
percentAlong Number
-
This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. Applicable to line features only.
ExampleLine feature with objectId 100 with 2 midspan junctions (j1,j2). The line feature has 3 edge network elements F-j1, j1-j2 and j2-T. OID=100 F------j1------j2------T F-j1 (objectId=100, positionFrom=0, positionTo=0.33) j1-j2 (objectId=100, positionFrom=0.33, positionTo=0.66) j2-T (objectId=100, positionFrom=0.66, positionTo=1) When percentAlong is 0.5 (50%) the starting location will be placed on the middle edge (j1-j2) OID=100 F------j1---x--j2------T When percentAlong is 0.1 (10%) the starting location will be placed on the first edge (F-j1) OID=100 F-x----j1------j2------T
-
terminalId
terminalId Number
-
The terminal Id to place the starting location at. Applicable for junction/device sources only. Users can use
getTerminalConfiguration()
in UtilityNetwork to get the terminal.- See also
-
type
type String
-
The type of the trace location;
starting-point
defines where the trace should start andbarrier
defines where the trace should stop.Possible Values:"starting-point" |"barrier"
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. | TraceLocation | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | TraceLocation |
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
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.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 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"); }
-
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
toJSON(){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.