GPOptions | References | ArcGIS Maps SDK for JavaScript

import GPOptions from "@arcgis/core/rest/geoprocessor/GPOptions.js";

Inheritance:: GPOptions→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.19

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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`GPOptionsProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`outSpatialReference`	`SpatialReference \| null \| undefined`
`processExtent`	`Extent \| null \| undefined`
`processSpatialReference`	`SpatialReference \| null \| undefined`
`returnColumnName`	`boolean`
`returnFeatureCollection`	`boolean`
`returnM`	`boolean`
`returnZ`	`boolean`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

outSpatialReference

autocast Property

Type: SpatialReference | null | undefined

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.

processExtent

autocast Property

Type: Extent | null | undefined

Limits processing to features within this extent.

processSpatialReference

autocast Property

Type: SpatialReference | null | undefined

The spatial reference that the model will use to perform geometry operations. If processSpatialReference is specified and outSpatialReference 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 outSpatialReference 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.

returnColumnName

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 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 property is referenced by execute() and JobInfo.fetchResultData().

See also

Geoprocessing service data types - GPValueTable

Default value: false

returnFeatureCollection

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.31

When true, a parameter value of type "feature-record-set-layer" will be returned as a feature layer rather than a feature set. This property is referenced by execute() and JobInfo.fetchResultData(). The default is false.

See also

Default value: false

returnM

Property

Type: boolean

Returns geometry with measures when LastMileDeliveryParameters.routeShape is shape-with-measures. 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

Property

Type: boolean

Returns geometry with heights (z) if and when the source network dataset contains height information. 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