UNTraceConfiguration | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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	Specifies whether to allow IndeterminateFlow.	UNTraceConfiguration
String	Allows users to input arcade expressions.	UNTraceConfiguration
String	Specifies the diagram Template Name.	UNTraceConfiguration
String	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	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	Specifies where the filter will be applied.	UNTraceConfiguration
Boolean	Specifies if the container features will be included in the trace results.	UNTraceConfiguration
Boolean	Specifies if the content in containers will be included in the results.	UNTraceConfiguration
Boolean	Specifies whether to include isolated features for an isolation trace.	UNTraceConfiguration
Boolean	Specifies if structure features and objects will be included in the trace results.	UNTraceConfiguration
Boolean	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
Object	Specifies the parameters needed for calculating nearest neighbors.	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	Specifies the name of the subnetwork where the trace will be run.	UNTraceConfiguration
String	Specifies the name of the tier where an upstream or downstream trace ends.	UNTraceConfiguration
String	Specifies the name of the tier where the trace will be run.	UNTraceConfiguration
Boolean	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

Specifies whether to allow IndeterminateFlow.

arcadeExpressionBarrier Property arcadeExpressionBarrier String

Allows users to input arcade expressions.

diagramTemplateName Property diagramTemplateName String

Specifies the diagram Template Name.

domainNetworkName Property domainNetworkName String

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

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

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

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

includeContent Property includeContent Boolean

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

includeIsolated Property includeIsolated Boolean

Specifies whether to include isolated features for an isolation trace.

includeStructures Property includeStructures Boolean

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

includeUpToFirstSpatialContainer Property includeUpToFirstSpatialContainer Boolean

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.

nearestNeighbor Property nearestNeighbor Object

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.

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

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

targetTierName Property targetTierName String

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

See also

Tiers - ArcGIS Pro

tierName Property tierName String

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

See also

validateLocatability Property validateLocatability Boolean

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