import ParameterValue from "@arcgis/core/rest/support/ParameterValue.js";const ParameterValue = await $arcgis.import("@arcgis/core/rest/support/ParameterValue.js");- Inheritance:
- ParameterValue→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.0
Represents the output parameters of a geoprocessor method and their properties and values.
- See also
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
value
- Type
- T["value"]
The value of the parameter. The structure of this value depends on the data type of the parameter. The value could be a single value or an array of values. The table below lists the singular data types.
| Data Type | JavaScript Type |
|---|---|
| areal-unit | ArealUnit |
| boolean | Boolean |
| data-file | DataFile |
| date | Date |
| double | Number (float) |
| feature-record-set-layer | FeatureSet, DataFile, or FeatureLayer |
| field | Field |
| linear-unit | LinearUnit |
| long | Number (int) |
| raster-data | RasterData or MapImage |
| raster-data-layer | RasterData or MapImage |
| record-set | FeatureSet or DataFile |
| string | String |
| time-unit | TimeUnit |
| value-table | Value table is a flexible table-like object consisting of rows and columns containing various values. |
Alternatively, this property could be an array of values. The table below lists all valid arrays.
| Data Type | JavaScript Type |
|---|---|
| multi-value-areal-unit | An array of areal units |
| multi-value-boolean | An array of booleans |
| multi-value-composite | An array containing any combination of singular data types in the table above excluding value-table. See GPComposite. |
| multi-value-data-file | An array of data files |
| multi-value-date | An array of dates |
| multi-value-double | An array of doubles |
| multi-value-feature-record-set-layer | An array of feature sets, data files, or feature layers |
| multi-value-field | An array of fields |
| multi-value-linear-unit | An array of linear units |
| multi-value-long | An array of longs |
| multi-value-raster-data | An array of rasters or map images |
| multi-value-raster-data-layer | An array of rasters or map images |
| multi-value-record-set | An array of feature sets or data files |
| multi-value-time-unit | An array of Time units |
| multi-value-string | An array of strings |
- See also
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.