ParameterValue

AMD: require(["esri/rest/support/ParameterValue"], (ParameterValue) => { /* code goes here */ });
ESM: import ParameterValue from "@arcgis/core/rest/support/ParameterValue";
Class: esri/rest/support/ParameterValue
Inheritance: ParameterValue Accessor
Since: ArcGIS API for JavaScript 4.0

Represents the output parameters of a geoprocessor method and their properties and values.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

Specifies the parameter's data type.

more detailsParameterValue
Stringmore details

The name of the class.

more detailsAccessor
Boolean|DataFile|Date|Number|FeatureSet|Field|LinearUnit|RasterData|String|Array<(Boolean|DataFile|Date|Number|FeatureSet|Field|LinearUnit|RasterData|String)>more details

The value of the parameter.

more detailsParameterValue

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"

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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

Data Type JavaScript Type
boolean Boolean
data-file DataFile
date Date
double Number (float)
feature-record-set-layer FeatureSet
field Field
linear-unit LinearUnit
long Number (int)
raster-data RasterData
raster-data-layer RasterData
record-set FeatureSet
string String
multi-value Object[] - An array of any of the objects listed above.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
*more details

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

more detailsParameterValue
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor
Objectmore details

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

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 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.

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:
Type Description
* Returns a new instance of this class.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.