ParameterValue

Class: esri/tasks/support/ParameterValue
Inheritance: ParameterValue Accessor
Since: ArcGIS API for JavaScript 4.0

Represents the output parameters of a Geoprocessor task and their properties and values.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

Specifies the parameter's data type.

more details
more detailsParameterValue
String

The name of the class.

more details
more detailsAccessor
Object

The value of the parameter.

more details
more detailsParameterValue

Property Details

dataTypeString

Specifies the parameter's data type.

Possible Values: string | double | long | boolean | date | linear-unit | data-file | raster-data | record-set | raster-data-layer | feature-record-set-layer | multi-value

declaredClassStringreadonly inherited

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

valueObject

The value of the parameter. The data structure of this value depends on the dataType.

Data TypeJavaScript Type
stringString
doubleNumber (float)
longNumber (int)
booleanBoolean
dateDate
linear-unitLinearUnit
data-fileDataFile
raster-dataRasterData
record-setFeatureSet
raster-data-layerRasterData
feature-record-set-layerFeatureSet
multi-valueString[]

Method Overview

NameReturn TypeSummaryClass
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsParameterValue
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsParameterValue

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.