TraceLocation

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

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

new TraceLocation(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
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The globalId (UUID) of the feature to start or stop the trace.

more detailsTraceLocation
Booleanmore details

This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers.

more detailsTraceLocation
Numbermore details

This double parameter of value of 0-1 indicates a percentage along the line of where the starting location is placed.

more detailsTraceLocation
Numbermore details

The terminal Id to place the starting location at.

more detailsTraceLocation
Stringmore details

The type of the trace location; starting-point defines where the trace should start and barrier defines where the trace should stop.

more detailsTraceLocation

Property Details

declaredClass Stringreadonly inherited

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

globalId String

The globalId (UUID) of the feature to start or stop the trace.

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 to true, 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 Number

This double parameter of value of 0-1 indicates a percentage along the line of where the starting location is placed. Applicable to line features only.

Example:
Line 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 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 String

The type of the trace location; starting-point defines where the trace should start and barrier defines where the trace should stop.

Possible Values:"starting-point"|"barrier"

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

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

more detailsTraceLocation

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.