UNTraceConfiguration

AMD: require(["esri/networks/support/UNTraceConfiguration"], (UNTraceConfiguration) => { /* code goes here */ });
ESM: import UNTraceConfiguration from "@arcgis/core/networks/support/UNTraceConfiguration";
Class: esri/networks/support/UNTraceConfiguration
Since: ArcGIS API 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

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

Name Type Summary Class
Stringmore details

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

more detailsUNTraceConfiguration
Object[]more details

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

more detailsUNTraceConfiguration
Stringmore details

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

more detailsUNTraceConfiguration
Object[]more details

An array of objects representing filter function barriers.

more detailsUNTraceConfiguration
Stringmore details

Specifies where the filter will be applied.

more detailsUNTraceConfiguration
Booleanmore details

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

more detailsUNTraceConfiguration
Booleanmore details

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

more detailsUNTraceConfiguration
Booleanmore details

Specifies whether to include isolated features for an isolation trace.

more detailsUNTraceConfiguration
Booleanmore details

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

more detailsUNTraceConfiguration
Booleanmore details

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.

more detailsUNTraceConfiguration
Objectmore details

Specifies the parameters needed for calculating nearest neighbors.

more detailsUNTraceConfiguration
Object[]more details

An array of objects representing the output filter categories.

more detailsUNTraceConfiguration
Object[]more details

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

more detailsUNTraceConfiguration
Object[]more details

A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal.

more detailsUNTraceConfiguration
Stringmore details

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

more detailsUNTraceConfiguration
Stringmore details

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

more detailsUNTraceConfiguration
Stringmore details

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

more detailsUNTraceConfiguration
Booleanmore details

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

more detailsUNTraceConfiguration

Property Details

domainNetworkName String

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

See also:
filterBarriers Object[]

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

filterBitsetNetworkAttributeName String

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

filterFunctionBarriers Object[]

An array of objects representing filter function barriers.

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 Boolean

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

includeContent Boolean

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

includeIsolated Boolean

Specifies whether to include isolated features for an isolation trace.

includeStructures Boolean

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

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 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 Object[]

An array of objects representing the output filter categories.

outputFilters Object[]

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

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:
subnetworkName String

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

targetTierName String

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

See also:
tierName String

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

See also:
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.