geoprocessor

AMD: require(["geoscene/rest/geoprocessor"], (geoprocessor) => { /* code goes here */ });
ESM: import * as geoprocessor from "@geoscene/core/rest/geoprocessor";
类: geoscene/rest/geoprocessor
起始版本:GeoScene Maps SDK for JavaScript 4.19

表示 GeoScene REST API 公开的 GP 资源。GP 资源表示使用 GeoScene Server 发布的 GP 服务中的单个任务,它支持以下操作之一,具体取决于服务的设置方式:

  • execute - 当执行类型为同步时。
  • submitJob - 当执行类型为异步时。

如果未设置 processExtent,则 executesubmitJob 将格式化与 GeoScene 1.6.1 之前版本相兼容的 web 请求。

方法概述

名称 返回值类值 描述 对象
Promise<Object>

向服务器发送请求以执行同步 GP 任务。

更多详情
geoprocessor
Promise<JobInfo>

向服务器提交作业以供 GP 任务进行异步处理。

更多详情
geoprocessor

方法详细说明

execute(url, params, options, requestOptions){Promise<object>}

向服务器发送请求以执行同步 GP 任务。

可以使用 fetchResultData()fetchResultImage()fetchResultMapImageLayer() 方法检索结果。

参数
url String

表示地理处理服务的 GeoScene Server REST 资源的 URL。

params Object
optional

指定任务接受的输入参数及其对应的值。这些输入参数列在与 GP 任务资源相关的参数字段中。例如,假设 GP 任务资源具有以下输入参数:

  • <GPFeatureRecordSetLayer> Input_Points
  • <GPDouble> Distance

然后 params 参数将是以下形式的类:

{
 Input_Points: <FeatureSet>,
 Distance: <Number>
}

options GPOptions
optional

指定地理处理服务返回值的输入选项。options 参数将是以下形式的类:

{
  returnZ: true
}

requestOptions Object
optional

用于数据请求的附加选项(将覆盖构造期间定义的 requestOptions)。

返回
类型 描述
Promise<Object> 解析后,返回具有以下属性的类:
{
  messages: <GPMessage[]>,
  results: <ParameterValue[]>
}
有关此对象中的信息的更多信息,请参阅 GPMessageParameterValue 类。
submitJob(url, params, options, requestOptions){Promise<JobInfo>}

向服务器提交作业以供 GP 任务进行异步处理。该方法将在作业提交到服务器后立即解析。使用 waitForJobCompletion() 可在作业完成时收到通知,并且可以选择定期的作业状态。

可以使用 fetchResultData()fetchResultImage()fetchResultMapImageLayer() 方法检索结果。

参数
url String

表示地理处理服务的 GeoScene Server REST 资源的 URL。

params Object
optional

指定任务接受的输入参数及其对应的值。这些输入参数列在与 GP 任务资源相关的参数字段中。例如,假设 GP 任务资源具有以下输入参数:

  • <GPFeatureRecordSetLayer> Input_Points
  • <GPDouble> Distance

然后 params 参数将是以下形式的类:

{
  Input_Points: <FeatureSet>,
  Distance: <Number>
}

options GPOptions
optional

指定地理处理服务返回值的输入选项。options 参数将是以下形式的类:

{
  returnZ: true
}

requestOptions Object
optional

用于数据请求的附加选项(将覆盖构造期间定义的 requestOptions)。

返回
类型 描述
Promise<JobInfo> 解析后,返回 JobInfo

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息