Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ParameterValue
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/ParameterValue"], function(ParameterValue) { /* code goes here */ });
Description
(Added at v1.0)
Represent the output parameters of a GP task and their properties and values. ParameterValue has no constructor.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| dataType | String | Specifies the type of data for the parameter. |
| paramName | String | The name of the output parameter as defined by the geoprocessing task in the Services Directory. |
| value | Object | The value of the parameter. |
Property Details
<String
StringSpecifies the type of data for the parameter. It can have one of the following values: "GPString", "GPDouble", "GPLong", "GPBoolean", "GPDate", "GPLinearUnit", "GPDataFile", "GPRasterData", "GPRecordSet", "GPRasterDataLayer", "GPFeatureRecordSetLayer","GPMultiValue".
<String
StringThe name of the output parameter as defined by the geoprocessing task in the Services Directory.
<Object
ObjectThe value of the parameter. The data structure of this value depends on the dataType.
| Data Type | JavaScript Type | Example |
|---|---|---|
| GPString | String | "MyString" |
| GPDouble | Number (float) | 12.56 |
| GPLong | Number (int) | 345 |
| GPBoolean | Boolean | true |
| GPDate | <esri.tasks.Date> | |
| GPLinearUnit | <LinearUnit> | |
| GPDataFile | <DataFile> | |
| GPRasterData | <RasterData> | |
| GPRecordSet | <FeatureSet> | |
| GPRasterDataLayer | <RasterData> | |
| GPFeatureRecordSetLayer | <FeatureSet> | |
| GPMultiValue | String[] | ["Parcels", "Street Lights"] |