Skip to content
import ParameterValue from "@arcgis/core/rest/support/ParameterValue.js";
Inheritance:
ParameterValueAccessor
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

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
T["dataType"]
declaredClass
readonly inherited
T["value"]

dataType

Property
Type
T["dataType"]

Specifies the parameter's data type.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

paramName

Property
Type
string | null | undefined
Since
ArcGIS Maps SDK for JavaScript 4.28

The name of the parameter the value is for.

value

Property
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 TypeJavaScript Type
areal-unitArealUnit
booleanBoolean
data-fileDataFile
dateDate
doubleNumber (float)
feature-record-set-layerFeatureSet, DataFile, or FeatureLayer
fieldField
linear-unitLinearUnit
longNumber (int)
raster-dataRasterData or MapImage
raster-data-layerRasterData or MapImage
record-setFeatureSet or DataFile
stringString
time-unitTimeUnit
value-tableValue 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 TypeJavaScript Type
multi-value-areal-unitAn array of areal units
multi-value-booleanAn array of booleans
multi-value-compositeAn array containing any combination of singular data types in the table above excluding value-table. See GPComposite.
multi-value-data-fileAn array of data files
multi-value-dateAn array of dates
multi-value-doubleAn array of doubles
multi-value-feature-record-set-layerAn array of feature sets, data files, or feature layers
multi-value-fieldAn array of fields
multi-value-linear-unitAn array of linear units
multi-value-longAn array of longs
multi-value-raster-dataAn array of rasters or map images
multi-value-raster-data-layerAn array of rasters or map images
multi-value-record-setAn array of feature sets or data files
multi-value-time-unitAn array of Time units
multi-value-stringAn array of strings
See also

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
toJSON
inherited
toJSON(): any

fromJSON

inheritedstatic Method
Signature
fromJSON (json: any): any
Inherited from: JSONSupportMixin

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
ParameterTypeDescriptionRequired
json
any

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

inherited Method
Signature
toJSON (): any
Inherited from: JSONSupportMixin

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.