import TraceLocation from "@arcgis/core/rest/networks/support/TraceLocation.js";const TraceLocation = await $arcgis.import("@arcgis/core/rest/networks/support/TraceLocation.js");- Inheritance:
- TraceLocation→
Accessor
- Since
- ArcGIS Maps SDK 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
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
isFilterBarrier
- Type
- 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
- Type
- 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.
Example
Line feature with objectId 100 with 2 midspan junctions (j1,j2). The line feature has 3 edge network elementsF-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
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.
The telecom domain network no longer uses terminal IDs as of beta 2. However, as of beta 2, point features and junction objects used as a TraceLocation in a telecom domain network must specify terminalId: 1, else the trace location cannot be found.
- See also
type
- Type
- TraceLocationType
The type of the trace location; starting-point defines where the trace should start and barrier defines where the trace should stop.
The stopping-point type is reserved for future use.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
clone
- Signature
-
clone (): this
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
- Returns
- this
A deep clone of the class instance that invoked this method.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.