Class: GeoprocessingService

SuperMap.GeoprocessingService

地理处理服务接口的基类。

new SuperMap.GeoprocessingService(url, options)

common/iServer/GeoprocessingService.js, line 4
Name Type Description
url string

服务地址。
options Object

参数。

Name Type Default Description
events SuperMap.Events

处理所有事件的对象。
serverType SuperMap.ServerType SuperMap.ServerType.ISERVER 可选

服务器类型，iServer|iPortal|Online。
eventListeners Object 可选

事件监听器对象。有 processCompleted 属性可传入处理完成后的回调函数。processFailed 属性传入处理失败后的回调函数。
Version:
  • 10.1.0

Extends

Methods

inherited ajaxPolling()

common/iServer/CommonServiceBase.js, line 247

请求失败后，如果剩余请求失败次数不为 0，重新获取 URL 发送请求

inherited calculatePollingTimes()

common/iServer/CommonServiceBase.js, line 265

计算剩余请求失败执行次数。

cancelJob(identifier, jobId)

common/iServer/GeoprocessingService.js, line 127

取消地理处理任务的异步执行。

Name Type Description
identifier string

地理处理工具ID。
jobId string

地理处理任务ID。

inherited destroy()

common/iServer/CommonServiceBase.js, line 121

释放资源，将引用的资源属性置空。

execute(identifier, parameter, environment)

common/iServer/GeoprocessingService.js, line 40

同步执行地理处理工具。

Name Type Description
identifier string

地理处理工具ID。
parameter Object

地理处理工具的输入参数。
environment Object

地理处理工具的环境参数。

inherited getCredential(url){SuperMap.Credential}

common/iServer/CommonServiceBase.js, line 189

获取凭据信息

Name Type Description
url string

服务地址。
Returns:
Type Description
SuperMap.Credential 凭据信息对象。

getJobInfo(identifier, jobId)

common/iServer/GeoprocessingService.js, line 117

获取地理处理任务的执行信息。

Name Type Description
identifier string

地理处理工具ID。
jobId string

地理处理任务ID。

getJobs(identifier)

common/iServer/GeoprocessingService.js, line 136

获取地理处理服务任务列表。

Name Type Description
identifier string

地理处理工具ID。(传参代表identifier算子的任务列表，不传参代表所有任务的列表)

getResults(identifier, jobId, filter)

common/iServer/GeoprocessingService.js, line 148

地理处理工具执行的结果等,支持结果过滤。

Name Type Description
identifier string

地理处理工具ID。
jobId string

地理处理任务ID。
filter string

输出异步结果的id。(可选，传入filter参数时对该地理处理工具执行的结果进行过滤获取，不填参时显示所有的执行结果)

getTool(identifier)

common/iServer/GeoprocessingService.js, line 32

获取地理处理工具的ID、名称、描述、输入参数、环境参数和输出结果等相关参数。

Name Type Description
identifier string

地理处理工具ID。

getTools()

common/iServer/GeoprocessingService.js, line 25

获取地理处理工具列表。

inherited getUrlCompleted(result)

common/iServer/CommonServiceBase.js, line 220

请求成功后执行此方法。

Name Type Description
result Object

服务器返回的结果对象。

inherited getUrlFailed(result)

common/iServer/CommonServiceBase.js, line 231

请求失败后执行此方法。

Name Type Description
result Object

服务器返回的结果对象。

inherited isServiceSupportPolling()

common/iServer/CommonServiceBase.js, line 292

判断服务是否支持轮询。

inherited request(options)

common/iServer/CommonServiceBase.js, line 149
Name Type Description
options Object

参数。

Name Type Default Description
method string 'GET' 可选

请求方式，包括 "GET"，"POST"，"PUT"，"DELETE"。
url string 可选

发送请求的地址。
params Object 可选

作为查询字符串添加到 URL 中的一组键值对，此参数只适用于 GET 方式发送的请求。
data string 可选

发送到服务器的数据。
success function

请求成功后的回调函数。
failure function

请求失败后的回调函数。
scope Object 可选

如果回调函数是对象的一个公共方法，设定该对象的范围。
isInTheSameDomain boolean 可选

请求是否在当前域中。
withCredentials boolean false 可选

请求是否携带 cookie。
crossOrigin boolean 可选

是否允许跨域请求。
headers Object 可选

请求头。

inherited serviceProcessCompleted(result)

common/iServer/CommonServiceBase.js, line 304

状态完成，执行此方法。

Name Type Description
result Object

服务器返回的结果对象。

inherited serviceProcessFailed(result)

common/iServer/CommonServiceBase.js, line 316

状态失败，执行此方法。

Name Type Description
result Object

服务器返回的结果对象。

submitJob(identifier, parameter, environments)

common/iServer/GeoprocessingService.js, line 53

异步执行地理处理工具。

Name Type Description
identifier string

地理处理工具ID。
parameter Object

地理处理工具的输入参数。
environments Object

地理处理工具的环境参数。

waitForJobCompletion(jobId, identifier, options)

common/iServer/GeoprocessingService.js, line 75

获取地理处理异步执行状态信息。

Name Type Description
jobId string

地理处理任务ID。
identifier string

地理处理工具ID。
options Object

状态信息参数。

Name Type Description
interval number

定时器时间间隔。
statusCallback Callback

任务状态的回调函数。