A trace can optionally return a aggregated function result if the trace configuration asked for it. An example sum or an average of a network attribute.
- See also:
Constructors
-
new FunctionResult(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | more details The name of the class. | more details | Accessor | |
| String | more details The aggregate function type used in the supplied trace configuration. | more details | FunctionResult | |
| String | more details The name of the function result. | more details | FunctionResult | |
| Number | more details Actual result of the aggregate function. | more details | FunctionResult |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
functionType Stringreadonly
-
The aggregate function type used in the supplied trace configuration.
Possible Values:"add"|"subtract"|"average"|"count"|"min"|"max"
-
name Stringreadonly
-
The name of the function result.
-
result Numberreadonly
-
Actual result of the aggregate function.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | FunctionResult | |
| Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | FunctionResult |
Method Details
-
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
jsonparameter 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 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.
Returns:Type Description * Returns a new instance of this class.
-
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.