ParameterValue

AMD: require(["esri/rest/support/ParameterValue"], (ParameterValue) => { /* code goes here */ });
ESM: import ParameterValue from "@arcgis/core/rest/support/ParameterValue.js";
Class: esri/rest/support/ParameterValue
Inheritance: ParameterValue Accessor
Since: ArcGIS Maps SDK 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

Specifies the parameter's data type.

ParameterValue

The name of the class.

Accessor

The name of the parameter the value is for.

ParameterValue

The value of the parameter.

ParameterValue

Property Details

dataType

Property
dataType String

Specifies the parameter's data type.

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

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

paramName

Property
paramName String
Since: ArcGIS Maps SDK for JavaScript 4.28 ParameterValue since 4.0, paramName added at 4.28.

The name of the parameter the value is for.

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 Type JavaScript Type
areal-unit ArealUnit
boolean Boolean
data-file DataFile
date Date
double Number (float)
feature-record-set-layer FeatureSet, DataFile, or FeatureLayer
field Field
linear-unit LinearUnit
long Number (int)
raster-data RasterData or MapImage
raster-data-layer RasterData or MapImage
record-set FeatureSet or DataFile
string String
value-table Value 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 Type JavaScript Type
multi-value-areal-unit An array of areal units
multi-value-boolean An array of booleans
multi-value-composite An array containing any combination of singular data types in the table above excluding value-table. See GPComposite.
multi-value-data-file An array of data files
multi-value-date An array of dates
multi-value-double An array of doubles
multi-value-feature-record-set-layer An array of feature sets, data files, or feature layers
multi-value-field An array of fields
multi-value-linear-unit An array of linear units
multi-value-long An array of longs
multi-value-raster-data An array of rasters or map images
multi-value-raster-data-layer An array of rasters or map images
multi-value-record-set An array of feature sets or data files
multi-value-string An array of strings

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

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

Accessor
*

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

ParameterValue

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

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

ParameterValue

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON

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

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

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