require(["esri/rest/geoprocessor/GPOptions"], (GPOptions) => { /* code goes here */ });
import GPOptions from "@arcgis/core/rest/geoprocessor/GPOptions.js";
esri/rest/geoprocessor/GPOptions
A convenience module for providing input options for the geoprocessing service return values.
Property Overview
Name | Type | Summary | Object |
---|---|---|---|
The spatial reference of the output geometries. | GPOptions | ||
ProcessExtent, if specified, will only process features that overlap this extent. | GPOptions | ||
The spatial reference that the model will use to perform geometry operations. | GPOptions | ||
When | GPOptions | ||
If | GPOptions | ||
If | GPOptions |
Property Details
-
outSpatialReference
outSpatialReference SpatialReferenceautocast
-
The spatial reference of the output geometries. If not specified, the output geometries will be in the spatial reference of the input geometries. If processSpatialReference is specified and
outSpatialReference
is not specified, the output geometries will be in the spatial reference of the process spatial reference.- Default Value:null
-
ProcessExtent, if specified, will only process features that overlap this extent.
- Default Value:null
-
processSpatialReference
processSpatialReference SpatialReferenceautocast
-
The spatial reference that the model will use to perform geometry operations. If
processSpatialReference
is specified and outputSpatialReference is not specified, the output geometries will be in the spatial reference of the process spatial reference.A possible common scenario for using
processSpatialReference
andoutputSpatialReference
is that you would like to perform spatial operations like buffer or clip on a projected coordinate system such as web mercator. And you would like to recieve the output based on a geographic coordinates such as WGS84.- Default Value:null
-
returnColumnName
returnColumnName Boolean
Since: ArcGIS Maps SDK for JavaScript 4.29GPOptions since 4.19, returnColumnName added at 4.29. -
When
true
, individual values in a value table will be prefixed with the associated column name. If false, the default, a value table will consist as a two dimensional array of values. This properties is referenced by esri/rest/geoprocessor/execute and JobInfo.- Default Value:false
- See also
-
returnM
returnM Boolean
-
If
true
, m-values will be included in the results if the features have m-values. Otherwise, m-values are not returned. The default is false.- Default Value:false
-
returnZ
returnZ Boolean
-
If
true
, z-values will be included in the results if the features have z-values. Otherwise, z-values are not returned. The default is false.- Default Value:false