TraceParameters

Property Overview

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

gdbVersion String

The geodatabase version to execute the function against. Defaults to SDE.DEFAULT when no version is provided.

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

• Learn more about branch versioning

namedTraceConfigurationGlobalId String

The globalId (UUID) of the named trace configuration persisted in the network.

outSpatialReference SpatialReference

The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).

resultTypes ResultTypeJSON[]

Parameter specifying the types of results to return after running a trace.

traceConfiguration UNTraceConfiguration

Defines the properties of a trace.

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 to none.

traceType String

The trace type defined in this trace configuration.

Possible Values:"connected"|"upstream"|"downstream"|"shortest-path"|"subnetwork"|"subnetwork-controllers"|"loops"|"isolation"

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key 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.

fromJSON(json){*}static

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.

Parameter

json Object A 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.

Returns

Type	Description
*	Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	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");
}

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

Type Definitions

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 Boolean Specifies whether to return geometry values in resultTypes.

includePropagatedValues Boolean Specifies whether to return propagated values in resultTypes.

networkAttributeNames String[] Specifies the network attribute names.

diagramTemplateName String Specifies the name of a predefined Diagram Template.

resultTypeFields Object[] 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"
 });