GPOptions

AMD: require(["esri/rest/geoprocessor/GPOptions"], (GPOptions) => { /* code goes here */ });
ESM: import GPOptions from "@arcgis/core/rest/geoprocessor/GPOptions";
Object: esri/rest/geoprocessor/GPOptions
Since: ArcGIS API for JavaScript 4.19

A convenience module for providing input options for the geoprocessing service return values.

Property Overview

Name Type Summary Object
SpatialReferencemore details

The spatial reference of the output geometries.

more detailsGPOptions
Extentmore details

ProcessExtent, if specified, will only process features that overlap this extent.

more detailsGPOptions
SpatialReferencemore details

The spatial reference that the model will use to perform geometry operations.

more detailsGPOptions
Booleanmore details

If true, m-values will be included in the results if the features have m-values.

more detailsGPOptions
Booleanmore details

If true, z-values will be included in the results if the features have z-values.

more detailsGPOptions

Property Details

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 Extentautocast

ProcessExtent, if specified, will only process features that overlap this extent.

Default Value:null
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 and outputSpatialReference 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
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 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

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