UNTraceConfiguration | References | ArcGIS Maps SDK for JavaScript

import UNTraceConfiguration from "@arcgis/core/networks/support/UNTraceConfiguration.js";

Inheritance:: UNTraceConfiguration→TraceConfiguration→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.23

The UNTraceConfiguration class contains properties required to define objects than can be used to run custom traces on utility networks. A UNTraceConfiguration differs from a TraceConfiguration slightly because a UNTraceConfiguration contains parameters that are only applicable or relevant to utility networks.

See also

Example

// create a new instance of UNTraceConfiguration
// and configure some parameters
const unTraceConfiguration = new UNTraceConfiguration({
  domainNetworkName: "Electric",
  tierName: "Electric Distribution",
  subnetworkName: "RMT003",
  includeContainers: true,
  validateConsistency: true,
  // Traversability
  conditionBarriers: [
    {
      name: "E:Device Status",
      type: "networkAttribute",
      operator: "equal",
      value: 1,
      combineUsingOr: false,
      isSpecificValue: true
    }
  ],
  traversabilityScope: "junctionsAndEdges",
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`UNTraceConfigurationProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`allowIndeterminateFlow`	`boolean \| null \| undefined`
`arcadeExpressionBarrier`	`string \| null \| undefined`
`circuitName`	`string \| null \| undefined`
`conditionBarriers` inherited	`BarrierJSON[]`	TraceConfiguration
`declaredClass` readonly inherited	`string`	Accessor
`diagramTemplateName`	`string \| null \| undefined`
`domainNetworkName`	`string \| null \| undefined`
`filterBarriers`	`BarrierJSON[]`
`filterBitsetNetworkAttributeName`	`string \| null \| undefined`
`filterFunctionBarriers`	`FunctionBarrierJSON[]`
`filterScope`	`"junctions" \| "edges" \| "junctionsAndEdges" \| null \| undefined`
`functionBarriers` inherited	`FunctionBarrierJSON[]`	TraceConfiguration
`functions` inherited	`FunctionJSON[]`	TraceConfiguration
`ignoreBarriersAtStartingPoints` inherited	`boolean \| null \| undefined`	TraceConfiguration
`includeBarriers` inherited	`boolean \| null \| undefined`	TraceConfiguration
`includeContainers`	`boolean \| null \| undefined`
`includeContent`	`boolean \| null \| undefined`
`includeIsolated`	`boolean \| null \| undefined`
`includeStructures`	`boolean \| null \| undefined`
`includeUpToFirstSpatialContainer`	`boolean \| null \| undefined`
`inferConnectivity`	`boolean \| null \| undefined`
`maxHops`	`number \| null \| undefined`
`nearestNeighbor`	`NearestNeighborJSON \| null \| undefined`
`numPaths`	`number \| null \| undefined`
`outputConditions` inherited	`OutputConditionJSON[]`	TraceConfiguration
`outputFilterCategories`	`Object[]`
`outputFilters`	`AssetJSON[]`
`propagators`	`PropagatorJSON[]`
`shortestPathNetworkAttributeName` inherited	`string \| null \| undefined`	TraceConfiguration
`subnetworkName`	`string \| null \| undefined`
`targetTierName`	`string \| null \| undefined`
`tierName`	`string \| null \| undefined`
`traversabilityScope` inherited	`"junctions" \| "edges" \| "junctionsAndEdges" \| null \| undefined`	TraceConfiguration
`validateConsistency` inherited	`boolean \| null \| undefined`	TraceConfiguration
`validateLocatability`	`boolean \| null \| undefined`

allowIndeterminateFlow

Property

Type: boolean | null | undefined

Specifies whether to allow IndeterminateFlow.

arcadeExpressionBarrier

Property

Type: string | null | undefined

Allows users to input arcade expressions.

circuitName

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

beta

Specifies the name of the circuit that will be traced. When a value is provided for this option, the starting location for the circuit is used as the starting point for the trace, and traceLocations is not required.

This option is only honored for circuit traces.

conditionBarriers

inherited Property

Type: BarrierJSON[]

Inherited from: TraceConfiguration

An array of objects representing network attribute or category conditions that serve as barriers.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

diagramTemplateName

Property

Type: string | null | undefined

Specifies the diagram Template Name.

domainNetworkName

Property

Type: string | null | undefined

Specifies the name of the domain network where the trace will be run.

See also

Domain networks - ArcGIS Pro

filterBarriers

Property

Type: BarrierJSON[]

An array of objects representing specific categories or network attributes where the trace will stop.

filterBitsetNetworkAttributeName

Property

Type: string | null | undefined

Ensures the trace results include any bit that is set in the starting points for the network attribute.

filterFunctionBarriers

Property

Type: FunctionBarrierJSON[]

An array of objects representing filter function barriers.

filterScope

Property

Type: "junctions" | "edges" | "junctionsAndEdges" | null | undefined

Specifies where the filter will be applied.

Value	Description
junctions	Filter will be applied to junctions only.
edges	Filter will be applied to edges only.
junctionsAndEdges	Filter will be applied to both junctions and edges.

functionBarriers

inherited Property

Type: FunctionBarrierJSON[]

Inherited from: TraceConfiguration

An array of objects representing function barriers. Function barriers define when a trace should stop when an aggregated function condition is satisfied. For example, stop the trace when the sum of the shape length network attribute exceeds 100 meters.

functions

inherited Property

Type: FunctionJSON[]

Inherited from: TraceConfiguration

An array of objects representing function. A function allows the ability to run calculations on network attributes associated with traced network features. Multiple functions can be specified for a single trace.

ignoreBarriersAtStartingPoints

inherited Property

Type: boolean | null | undefined

Inherited from: TraceConfiguration

Do not stop the trace if the starting point is a barrier.

includeBarriers

inherited Property

Type: boolean | null | undefined

Inherited from: TraceConfiguration

Specifies whether the traversability barrier features will be included in the trace results.

includeContainers

Property

Type: boolean | null | undefined

Specifies if the container features will be included in the trace results.

includeContent

Property

Type: boolean | null | undefined

Specifies if the content in containers will be included in the results.

includeIsolated

Property

Type: boolean | null | undefined

Specifies whether to include isolated features for an isolation trace.

includeStructures

Property

Type: boolean | null | undefined

Specifies if structure features and objects will be included in the trace results.

includeUpToFirstSpatialContainer

Property

Type: boolean | null | undefined

Specifies whether to limit the containers returned to include only those encountered up to, and including, the first spatial container for each network element in the trace results.

inferConnectivity

Property

Type: boolean | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

beta

Specifies whether the path trace will use connectivity inference to traverse containment associations to find a path between the specified starting and stopping location.

This option is only honored for path traces.

maxHops

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

beta

Specifies the maximum number of hops between edges allowed in the valid path, excluding the starting point. All edges and junction-junction connectivity associations are evaluated as having a fixed unit length of 1 on traversal. Terminal devices are evaluated as having a fixed unit length of 2.

This option is only honored for path or circuit traces.

nearestNeighbor

Property

Type: NearestNeighborJSON | null | undefined

Specifies the parameters needed for calculating nearest neighbors. Nearest neighbor is used to return a number of features of a certain type within a given distance.

numPaths

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

beta

Specifies the maximum number of paths that will be returned between a given set of starting points and stopping points for a valid path.

This option is only honored for path traces.

outputConditions

inherited Property

Type: OutputConditionJSON[]

Inherited from: TraceConfiguration

Specifies the type of features returned based on a network attribute or check for a category string. A condition barrier uses a network attribute, an operator, a type, and an attribute value.

See also

Trace REST API

outputFilterCategories

Property

Type: Object[]

An array of objects representing the output filter categories.

outputFilters

Property

Type: AssetJSON[]

An array of objects used to control what is returned in the results of a trace.

propagators

Property

Type: PropagatorJSON[]

A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. Propagators are only applicable to subnetwork-based traces (subnetwork, subnetworksource, upstream, or downstream).

See also

Attribute propagation - ArcGIS Pro

shortestPathNetworkAttributeName

inherited Property

Type: string | null | undefined

Inherited from: TraceConfiguration

Specifies the network attribute name used for determining the shortest path. The shortest path is calculated using a numeric network attribute such as shape length.

subnetworkName

Property

Type: string | null | undefined

Specifies the name of the subnetwork where the trace will be run.

targetTierName

Property

Type: string | null | undefined

Specifies the name of the tier where an upstream or downstream trace ends.

See also

Tiers - ArcGIS Pro

tierName

Property

Type: string | null | undefined

Specifies the name of the tier where the trace will be run.

See also

traversabilityScope

inherited Property

Type: "junctions" | "edges" | "junctionsAndEdges" | null | undefined

Inherited from: TraceConfiguration

Determines whether traversability is applied to both junctions and edges, junctions only, or edges only. For example, if we set the traversabilityScope to be junctions only, edges will not get evaluated against traversability conditions and filters.

Value	Description
junctions	Traversability will be applied to junctions only.
edges	Traversability will be applied to edges only.
junctionsAndEdges	Traversability will be applied to both junctions and edges.

validateConsistency

inherited Property

Type: boolean | null | undefined

Inherited from: TraceConfiguration

Specifies whether an error will be returned if dirty areas are encountered in any of the traversed features. If set to false the trace will succeed even when dirty areas were encountered. However, the trace results might not be consistent.

validateLocatability

Property

Type: boolean | null | undefined

Specifies if its necessary to validate whether traversed junction or edge objects have the necessary containment, attachment, or connectivity association in their association hierarchy.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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	`any`	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

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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.