ParameterValue
esri/tasks/support/ParameterValue
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | Specifies the parameter's data type. more details | more details | ParameterValue | |
String | The name of the class. more details | more details | Accessor | |
Object | The value of the parameter. more details | more details | ParameterValue |
Property Details
- dataType String
Specifies the parameter's data type.
Possible Values:"boolean"|"data-file"|"date"|"double"|"feature-record-set-layer"|"field"|"linear-unit"|"long"|"raster-data"|"raster-data-layer"|"record-set"|"string"|"multi-value"
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- value Object
The value of the parameter. The data structure of this value depends on the
dataType
.Data Type JavaScript Type string String double Number (float) long Number (int) boolean Boolean date Date linear-unit LinearUnit data-file DataFile raster-data RasterData record-set FeatureSet raster-data-layer RasterData feature-record-set-layer FeatureSet field Field multi-value Object[] An array of any of the objects listed above.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | 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 details | ParameterValue | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ParameterValue |
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 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.