require(["esri/rest/networks/support/TraceParameters"], (TraceParameters) => { /* code goes here */ });
import TraceParameters from "@arcgis/core/rest/networks/support/TraceParameters.js";
esri/rest/networks/support/TraceParameters
The list of parameters that are needed to determine how the trace analytic will be executed. This includes trace locations, type, trace configurations, result types, output, and many other parameters.
- See also
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 |
---|---|---|---|
The name of the class. | Accessor | ||
The geodatabase version to execute the function against. | TraceParameters | ||
The date/timestamp (in UTC) to execute the function at a given time. | TraceParameters | ||
The globalId (UUID) of the named trace configuration persisted in the network. | TraceParameters | ||
The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable). | TraceParameters | ||
Parameter specifying the types of results to return after running a trace. | TraceParameters | ||
Defines the properties of a trace. | TraceParameters | ||
The list of starting points and barriers that will define where the trace starts and stops. | TraceParameters | ||
The trace type defined in this trace configuration. | TraceParameters |
Property Details
-
gdbVersion
gdbVersion String
-
The geodatabase version to execute the function against. Defaults to
SDE.DEFAULT
when no version is provided.
-
moment
moment Date
-
The date/timestamp (in UTC) to execute the function at a given time. This could be used to run the function in a moment in the past or in long transaction mode (undo/redo). Applicable to branch versioned datasets only.
- See also
-
namedTraceConfigurationGlobalId
namedTraceConfigurationGlobalId String
-
The globalId (UUID) of the named trace configuration persisted in the network.
-
outSpatialReference
outSpatialReference SpatialReference
-
The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).
-
resultTypes
resultTypes ResultTypeJSON[]
-
Parameter specifying the types of results to return after running a trace.
-
traceConfiguration
traceConfiguration UNTraceConfiguration
-
Defines the properties of a trace.
-
traceLocations
traceLocations TraceLocation[]
-
The list of starting points and barriers that will define where the trace starts and stops. This parameter can be optional (defaults to empty array) if minStartingPoints in
NamedTraceConfiguration
is set tonone
.
-
traceType
traceType String
-
The trace type defined in this trace configuration.
Possible Values:"connected" |"upstream" |"downstream" |"shortest-path" |"subnetwork" |"subnetwork-controller" |"loops" |"isolation"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TraceParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | TraceParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
Type Definitions
-
ResultTypeJSON
ResultTypeJSON Object
-
ResultTypeJSON specifies the type of results to return after running a trace.
- Properties
-
type String
Specifies whether to return type
"elements"
or"aggregatedGeometry"
.Possible Values:"elements"|"aggregatedGeometry"
includeGeometry BooleanSpecifies whether to return geometry values in resultTypes.
includePropagatedValues BooleanSpecifies whether to return propagated values in resultTypes.
Specifies the network attribute names.
diagramTemplateName StringSpecifies the name of a predefined Diagram Template.
Specifies the types of output fields that can be generated from geoprocessing tools.
Example// Creates a new instance of this class and initializes it with values inputted in json format. A resultTypes object is passed into the resultTypes property. const traceParameters = TraceParameters.fromJSON({ traceConfigurationGlobalId: "{DF22DA8D-6EC0-408B-A8B2-E468EC7DC9BF}", moment: 1554214441244, gdbVersion: "SDE.DEFAULT", resultTypes: [ { type: "elements", includeGeometry: false, includePropagatedValues: false, networkAttributeNames: [], diagramTemplateName: "", resultTypeFields: [] }, { type: "aggregatedGeometry", includeGeometry: false, includePropagatedValues: false, networkAttributeNames: [], diagramTemplateName: "", resultTypeFields: [] } ], traceType: "subnetwork" });