Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Geoprocessor
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/Geoprocessor"], function(Geoprocessor) { /* code goes here */ });
Description
(Added at v1.0)
Represents a GP Task resource exposed by the ArcGIS Server REST API. A GP Task resource represents a single task in a GP service published using the ArcGIS Server and it supports one of the following operations:
- "execute" - performed on a GP Task resource when the execution type is synchronous.
- "submitJob" - performed on an asynchronous GP Task resource.
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new Geoprocessor(url) | Creates a new Geoprocessor object that represents the GP Task identifed by a URL. |
Properties
| Name | Type | Summary |
|---|---|---|
| outSpatialReference | SpatialReference | The spatial reference of the output geometries. |
| outputSpatialReference | SpatialReference | Deprecated at v2.0, use outSpatialReference instead.. |
| processSpatialReference | SpatialReference | The spatial reference that the model will use to perform geometry operations. |
| updateDelay | Number | The time interval in milliseconds between each job status request sent to an asynchronous GP task. |
| url | String | ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request. |
Methods
| Name | Return type | Summary |
|---|---|---|
| cancelJob(jobId, callback, errback) | Deferred | Cancel an asynchronous geoprocessing job. |
| cancelJobStatusUpdates(jobId) | None | Cancels the periodic job status updates initiated automatically when submitJob() is invoked for the job identified by jobId. |
| checkJobStatus(jobId, callback?, errback?) | Deferred | Sends a request to the GP Task for the current state of the job identified by jobId. |
| execute(inputParameters, callback?, errback?) | Deferred | Sends a request to the server to execute a synchronous GP task. |
| getResultData(jobId, parameterName, callback?, errback?) | Deferred | Sends a request to the GP Task to get the task result identified by jobId and resultParameterName. |
| getResultImage(jobId, parameterName, imageParameters, callback?, errback?) | Deferred | Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an image. |
| getResultImageLayer(jobId, parameterName?, imageParameters?, callback?) | ArcGISDynamicMapServiceLayer | Get the task result identified by jobId and resultParameterName as an ArcGISDynamicMapServiceLayer. |
| setOutSpatialReference(spatialReference) | None | Sets the well-known ID of the spatial reference of the output geometries. |
| setOutputSpatialReference(spatialReference) | None | Deprecated at v2.0, use setOutSpatialReference instead.. |
| setProcessSpatialReference(spatialReference) | None | Sets the well-known ID of the spatial reference that the model uses to perform geometry operations. |
| setUpdateDelay(delay) | None | Sets the time interval in milliseconds between each job status request sent to an asynchronous GP task. |
| submitJob(inputParameters, callback?, statusCallback?, errback?) | Deferred | Submits a job to the server for asynchronous processing by the GP task. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| error | {
error: < | Fires when an error occurs when executing the task. |
| execute-complete | {
messages: < | Fires when a synchronous GP task is completed. |
| get-result-data-complete | {
result: < | Fires when the result of an asynchronous GP task execution is available. |
| get-result-image-complete | {
mapImage: < | Fires when a map image is generated by invoking the getResultImage method. |
| get-result-image-layer-complete | Fires when getResultImageLayer method has completed. | |
| job-cancel | Fires when the geoprocessing job is cancelled using the cancelJob method. | |
| job-complete | Fires when an asynchronous GP task using submitJob is complete. | |
| status-update | Fires when a job status update is available. |
Constructor Details
Creates a new Geoprocessor object that represents the GP Task identifed by a URL.
Parameters:
< |
Required | URL to the ArcGIS Server REST resource that represents a geoprocessing service. An example is https://sampleserver6.arcgisonline.com/arcgis/rest/services/Viewshed/GPServer. For more information on constructing a URL, see The Services Directory and the REST API. |
Sample:
require([
"esri/tasks/Geoprocessor", ...
], function(Geoprocessor, ... ) {
var gp = new Geoprocessor("https://www.example.com/argis/rest/services/Specialty/ESRI_Currents_World/GPServer/MessageInABottle");
...
});
Property Details
<SpatialReference
SpatialReferenceThe spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries. If processSpatialReference is specified and outSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
<SpatialReference
SpatialReferenceDeprecated at v2.0, use outSpatialReference instead.
See also: setOutputSpatialReference()
<SpatialReference
SpatialReferenceThe spatial reference that the model will use to perform geometry operations. If processSpatialReference is specified and outputSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
See also: setProcessSpatialReference()
<Number
NumberThe time interval in milliseconds between each job status request sent to an asynchronous GP task.
Default value:
1000See also: setUpdateDelay()
<String
StringArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.
Method Details
Cancel an asynchronous geoprocessing job. Requires an ArcGIS Server 10.1 service or greater. (Added at v3.0)
Return type:
DeferredParameters:
< |
Required | A string that uniquely identifies a job on the server. It is created when a job is submitted for execution and later used to check its status and retrieve the results. |
< |
Required | The function to call when the method has completed. The arguments in the function are the same as the onJobCancel event. |
< |
Required | An error object is returned if an error occurs during task execution. |
Sample:
gp.cancelJob(jobId, function (info) {
console.log(info.jobStatus);
});
See also: on("job-cancel")
Cancels the periodic job status updates initiated automatically when submitJob() is invoked for the job identified by jobId. You can still obtain the status of this job by calling the checkStatus() method at your own discretion. (Added at v1.1)
Parameters:
< |
Required | A string that uniquely identifies the job for which the job updates are cancelled. |
Sends a request to the GP Task for the current state of the job identified by jobId. Upon receiving the response, the onStatusUpdate event is fired and the optional callback function is invoked.
Return type:
DeferredParameters:
< |
Required | A string that uniquely identifies a job on the server. It is created when a job is submitted for execution and later used to check its status and retrieve the results. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onStatusUpdate event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
Sends a request to the server to execute a synchronous GP task. On completion, execute-complete event is fired and the optional callback function is invoked.
Return type:
DeferredParameters:
< |
Required | The inputParameters argument specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters:
{
Input_Points: <FeatureSet>,
Distance: <Number>
}
|
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the execute-complete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
Sample:
require([
"esri/Geoprocessor", "dojo/dom", ...
], function(Geoprocessor, dom, ... ) {
var gp = new Geoprocessor( ... );
function executeGP(){
var params = { "Input_Point":featureSet, "Days": dom.byId("days").value };
gp.execute(params, displayTrack);
}
function displayTrack(results, messages) {
//do something with the results
var features = results[0].value.features;
}
...
});
See also: on("error"), on("execute-complete")
Sends a request to the GP Task to get the task result identified by jobId and resultParameterName. On completion, the getresultdatacomplete event will be fired and the optional callback function will be invoked.
Return type:
DeferredParameters:
< |
Required | The jobId returned from JobInfo. |
< |
Required | The name of the result parameter as defined in Services Directory. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onGetResultDataComplete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
See also: on("error"), on("get-result-data-complete")
Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an image.
Return type:
DeferredParameters:
< |
Required | The jobId returned from JobInfo. |
< |
Required | The name of the result parameter as defined in Services Directory. |
< |
Required | Specifies the properties of the result image. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onGetResultImageComplete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
See also: on("error"), on("get-result-image-complete")
Get the task result identified by jobId and resultParameterName as an ArcGISDynamicMapServiceLayer.
Return type:
ArcGISDynamicMapServiceLayerParameters:
< |
Required | The jobId returned from JobInfo. |
< |
Optional | The name of the result parameter as defined in Services Directory. As of 3.9, the parameterName parameter is now also optional and shouldn't be passed a value if using 10.1 or greater. |
< |
Optional | Contains various options that can be specified when generating a dynamic map image. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onGetResultImageLayerComplete event. |
Sample:
gp.getResultImageLayer(jobInfo.jobId, "Selected_Tax_Lot",imageParams, function(gpLayer){
gpLayer.setOpacity(0.5);
map.addLayer(gpLayer);
});
See also: on("error"), on("get-result-image-layer-complete")
Sets the well-known ID of the spatial reference of the output geometries.
Parameters:
< |
Required | The well-known ID of a spatial reference.
{"wkid" : 4326}
|
Sample:
gp.setOutSpatialReference({wkid:102100});
Deprecated at v2.0, use setOutSpatialReference instead.
Parameters:
< |
Required | The well-known ID of a spatial reference. |
See also: outputSpatialReference
Sets the well-known ID of the spatial reference that the model uses to perform geometry operations.
Parameters:
< |
Required | The well-known ID of a spatial reference.
{"wkid" : 4326}
|
See also: processSpatialReference
Sets the time interval in milliseconds between each job status request sent to an asynchronous GP task.
Parameters:
< |
Required | The value in milliseconds. One second equals 1000 milliseconds. |
See also: updateDelay
Submits a job to the server for asynchronous processing by the GP task. Once the job is submitted and until it is completed, the onStatusUpdate event is fired and the optional statusCallback() function is invoked at regular intervals, the duration of which is specified by the updateDelay property. Upon completion of the job, the onJobComplete event is fired and the optional callback function is invoked.
The task execution results can be retrieved using getResultData(), getResultImage() or getResultImageLayer() methods.
The task execution results can be retrieved using getResultData(), getResultImage() or getResultImageLayer() methods.
Return type:
DeferredParameters:
< |
Required | The inputParameters argument specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters:
{ Input_Points: <FeatureSet>, Distance: <Number> } |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onJobComplete event. |
< |
Optional | Checks the current status of the job. The returned JobInfo message includes the status along with the GPMessage. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
Sample:
require([
"esri/tasks/Geoprocessor", "esri/layers/ImageParameters", ...
], function(Geoprocessor, ImageParameters, ... ) {
var gp = new Geoprocessor( ... );
function executeGP() {
var params = { "Total_value_greater_than":numval};
gp.submitJob(params, completeCallback, statusCallback);
}
function statusCallback(jobInfo){
console.log(jobInfo.jobStatus);
}
function completeCallback(jobInfo) {
var imageParams = new ImageParameters();
imageParams.imageSpatialReference = map.spatialReference;
gp.getResultImageLayer(jobInfo.jobId, "Selected_Tax_Lot",imageParams, function(gpLayer){
gpLayer.setOpacity(0.5);
map.addLayer(gpLayer);
});
}
...
});
Event Details
[ On Style Events | Connect Style Event ]
Fires when an error occurs when executing the task. (Added at v3.6)
Event Object Properties:
< |
ArcGIS Server error message returned in a JavaScript error object. |
Fires when a synchronous GP task is completed. Should be used in favor of onExecuteComplete. (Added at v3.5)
Event Object Properties:
< |
An array of GPMessage that has the type and description. |
< |
An array of ParameterValue objects that gives access to the result parameters and the task execution messages. |
See also: execute()
Fires when the result of an asynchronous GP task execution is available. Should be used in favor of onGetResultDataComplete. (Added at v3.5)
Event Object Properties:
< |
Contains the result parameters and the task execution messages. |
See also: getResultData()
Fires when a map image is generated by invoking the getResultImage method. Should be used in favor of onGetResultImageComplete. (Added at v3.5)
Event Object Properties:
< |
Contains the properties of a dynamically generated map image. |
See also: getResultImage()
Fires when getResultImageLayer method has completed. Should be used in favor of onGetResultImageLayerComplete. (Added at v3.5)
See also: getResultImageLayer()
Fires when the geoprocessing job is cancelled using the cancelJob method. The returned object includes the status and job id. Should be used in favor of onJobCancel. (Added at v3.5)
See also: cancelJob()
Fires when an asynchronous GP task using submitJob is complete. Should be used in favor of onJobComplete. (Added at v3.5)
See also: submitJob()
Fires when a job status update is available. Should be used in favor of onStatusUpdate. (Added at v3.5)
See also: checkJobStatus()