import TraceParameters from "@arcgis/core/rest/networks/support/TraceParameters.js";const TraceParameters = await $arcgis.import("@arcgis/core/rest/networks/support/TraceParameters.js");- Inheritance:
- TraceParameters→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.20
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
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
ResultType[] | null | undefined | | |
| | ||
| | ||
| |
moment
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.
outSpatialReference
- Type
- SpatialReference | null | undefined
The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).
resultTypes
- Type
- ResultType[] | null | undefined
Parameter specifying the types of results to return after running a trace.
traceConfiguration
- Type
- UNTraceConfiguration | null | undefined
Defines the properties of a trace.
traceLocations
- Type
- 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 NamedTraceConfiguration.minStartingPoints in NamedTraceConfiguration is set to none.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.