require(["esri/networks/support/UNTraceConfiguration"], (UNTraceConfiguration) => { /* code goes here */ });
import UNTraceConfiguration from "@arcgis/core/networks/support/UNTraceConfiguration.js";
esri/networks/support/UNTraceConfiguration
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
// 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
Specifies whether to allow IndeterminateFlow. | UNTraceConfiguration | ||
Allows users to input arcade expressions. | UNTraceConfiguration | ||
Specifies the diagram Template Name. | UNTraceConfiguration | ||
Specifies the name of the domain network where the trace will be run. | UNTraceConfiguration | ||
An array of objects representing specific categories or network attributes where the trace will stop. | UNTraceConfiguration | ||
Ensures the trace results include any bit that is set in the starting points for the network attribute. | UNTraceConfiguration | ||
An array of objects representing filter function barriers. | UNTraceConfiguration | ||
Specifies where the filter will be applied. | UNTraceConfiguration | ||
Specifies if the container features will be included in the trace results. | UNTraceConfiguration | ||
Specifies if the content in containers will be included in the results. | UNTraceConfiguration | ||
Specifies whether to include isolated features for an isolation trace. | UNTraceConfiguration | ||
Specifies if structure features and objects will be included in the trace results. | UNTraceConfiguration | ||
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 | ||
Specifies the parameters needed for calculating nearest neighbors. | UNTraceConfiguration | ||
An array of objects representing the output filter categories. | UNTraceConfiguration | ||
An array of objects used to control what is returned in the results of a trace. | UNTraceConfiguration | ||
A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. | UNTraceConfiguration | ||
Specifies the name of the subnetwork where the trace will be run. | UNTraceConfiguration | ||
Specifies the name of the tier where an upstream or downstream trace ends. | UNTraceConfiguration | ||
Specifies the name of the tier where the trace will be run. | UNTraceConfiguration | ||
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
-
Specifies whether to allow IndeterminateFlow.
-
Allows users to input arcade expressions.
-
Specifies the diagram Template Name.
-
Specifies the name of the domain network where the trace will be run.
- See also
-
An array of objects representing specific categories or network attributes where the trace will stop.
-
Ensures the trace results include any bit that is set in the starting points for the network attribute.
-
An array of objects representing filter function barriers.
-
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"
-
Specifies if the container features will be included in the trace results.
-
Specifies if the content in containers will be included in the results.
-
Specifies whether to include isolated features for an isolation trace.
-
Specifies if structure features and objects will be included in the trace results.
-
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.
-
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.
-
An array of objects representing the output filter categories.
-
An array of objects used to control what is returned in the results of a trace.
-
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
-
Specifies the name of the subnetwork where the trace will be run.
-
Specifies the name of the tier where an upstream or downstream trace ends.
- See also
-
Specifies the name of the tier where the trace will be run.