UNTraceConfiguration | API Reference | ArcGIS Maps SDK for JavaScript

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

UNTraceConfiguration Constructor new UNTraceConfiguration(properties)

Parameter

properties Object

optional

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

Property Overview

Type	Summary	Class
Boolean\|null\|undefined	Specifies whether to allow IndeterminateFlow.	UNTraceConfiguration
String\|null\|undefined	Allows users to input arcade expressions.	UNTraceConfiguration
String\|null\|undefined	Specifies the name of the circuit that will be traced.	UNTraceConfiguration
String\|null\|undefined	Specifies the diagram Template Name.	UNTraceConfiguration
String\|null\|undefined	Specifies the name of the domain network where the trace will be run.	UNTraceConfiguration
Object []	An array of objects representing specific categories or network attributes where the trace will stop.	UNTraceConfiguration
String\|null\|undefined	Ensures the trace results include any bit that is set in the starting points for the network attribute.	UNTraceConfiguration
Object []	An array of objects representing filter function barriers.	UNTraceConfiguration
String\|null\|undefined	Specifies where the filter will be applied.	UNTraceConfiguration
Boolean\|null\|undefined	Specifies if the container features will be included in the trace results.	UNTraceConfiguration
Boolean\|null\|undefined	Specifies if the content in containers will be included in the results.	UNTraceConfiguration
Boolean\|null\|undefined	Specifies whether to include isolated features for an isolation trace.	UNTraceConfiguration
Boolean\|null\|undefined	Specifies if structure features and objects will be included in the trace results.	UNTraceConfiguration
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.	UNTraceConfiguration
Boolean\|null\|undefined	Specifies whether the path trace will use connectivity inference to traverse containment associations to find a path between the specified starting and stopping location.	UNTraceConfiguration
Number\|null\|undefined	Specifies the maximum number of hops between edges allowed in the valid path, excluding the starting point.	UNTraceConfiguration
Object\|null\|undefined	Specifies the parameters needed for calculating nearest neighbors.	UNTraceConfiguration
Number\|null\|undefined	Specifies the maximum number of paths that will be returned between a given set of starting points and stopping points for a valid path.	UNTraceConfiguration
Object []	An array of objects representing the output filter categories.	UNTraceConfiguration
Object []	An array of objects used to control what is returned in the results of a trace.	UNTraceConfiguration
Object []	A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal.	UNTraceConfiguration
String\|null\|undefined	Specifies the name of the subnetwork where the trace will be run.	UNTraceConfiguration
String\|null\|undefined	Specifies the name of the tier where an upstream or downstream trace ends.	UNTraceConfiguration
String\|null\|undefined	Specifies the name of the tier where the trace will be run.	UNTraceConfiguration
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.	UNTraceConfiguration

Property Details

allowIndeterminateFlow Property allowIndeterminateFlow Boolean |null |undefined

Specifies whether to allow IndeterminateFlow.

arcadeExpressionBarrier Property arcadeExpressionBarrier String |null |undefined

Allows users to input arcade expressions.

circuitName Property circuitName String |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.34 UNTraceConfiguration since 4.23, circuitName added at 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.

diagramTemplateName Property diagramTemplateName String |null |undefined

Specifies the diagram Template Name.

domainNetworkName Property domainNetworkName String |null |undefined

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

See also

Domain networks - ArcGIS Pro

filterBarriers Property filterBarriers Object[]

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

filterBitsetNetworkAttributeName Property filterBitsetNetworkAttributeName String |null |undefined

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

filterFunctionBarriers Property filterFunctionBarriers Object[]

An array of objects representing filter function barriers.

filterScope Property filterScope String |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.

Possible Values:"junctions" |"edges" |"junctionsAndEdges"

includeContainers Property includeContainers Boolean |null |undefined

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

includeContent Property includeContent Boolean |null |undefined

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

includeIsolated Property includeIsolated Boolean |null |undefined

Specifies whether to include isolated features for an isolation trace.

includeStructures Property includeStructures Boolean |null |undefined

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

includeUpToFirstSpatialContainer Property includeUpToFirstSpatialContainer 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 inferConnectivity Boolean |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.34 UNTraceConfiguration since 4.23, inferConnectivity added at 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 maxHops Number |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.34 UNTraceConfiguration since 4.23, maxHops added at 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 nearestNeighbor Object |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 numPaths Number |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.34 UNTraceConfiguration since 4.23, numPaths added at 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.

outputFilterCategories Property outputFilterCategories Object[]

An array of objects representing the output filter categories.

outputFilters Property outputFilters Object[]

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

propagators Property propagators Object[]

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

subnetworkName Property subnetworkName String |null |undefined

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

targetTierName Property targetTierName String |null |undefined

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

See also

Tiers - ArcGIS Pro

tierName Property tierName String |null |undefined

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

See also

validateLocatability Property validateLocatability 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.