JobInfo

属性概述

属性详细信息

declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className。

jobId String

GeoScene Server 分配的唯一作业 ID。

jobStatus String

作业状态。

可能值："job-cancelled"|"job-cancelling"|"job-deleted"|"job-deleting"|"job-timed-out"|"job-executing"|"job-failed"|"job-new"|"job-submitted"|"job-succeeded"|"job-waiting"

messages GPMessage[]

包含消息类型和描述的消息数组。

requestOptions Object

用于数据请求的选项。这些选项也可通过 requestOptions 方法参数进行控制。

sourceUrl String

接收地理处理请求的资源的 GeoScene Server Rest API 端点。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

cancelJob(jobId, requestOptions){Promise<JobInfo>}

取消异步地理处理作业。需要 GeoScene Server 1.1 服务或更高版本。

参数

jobId String 唯一标识服务器上的作业的字符串。它在提交作业以供执行时创建，并在之后用于检查其状态并检索结果。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

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

checkJobStatus(requestOptions){Promise<JobInfo>}

发送对该作业当前状态的请求。

参数

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

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

destroy()

停止监视此作业的状态更新。

// Stop monitoring this job for status updates.
jobInfo.destroy();

另请参阅

• jobInfo.waitForJobCompletion()

fetchResultData(resultName, gpOptions, requestOptions){Promise<ParameterValue>}

向 GP 任务发送请求，以获取由 resultName 标识的任务结果。

参数

resultName String 服务目录中定义的结果参数的名称。

gpOptions GPOptions optional 地理处理服务返回值的输入选项。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

类型	描述
Promise<ParameterValue>	解析后，返回一个名为 result 的 ParameterValue 类型的对象，其中包含结果参数和任务执行消息。

fetchResultImage(jobId, resultName, imageParams, requestOptions){Promise<ParameterValue>}

向 GP 任务发送请求，以图像形式获取由 jobId 和 resultName 标识的任务结果 。

参数

jobId String 从 JobInfo 返回的 jobid。

resultName String 服务目录中定义的结果参数的名称。

imageParams ImageParameters 指定结果影像的属性。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

类型	描述
Promise<ParameterValue>	解析后，返回具有 mapImage 属性的类型为 MapImage 的对象。

fetchResultMapImageLayer(jobId){Promise<MapImageLayer>}

以 MapImageLayer 形式获取由 jobId 标识的任务结果。

参数

jobId String 从 JobInfo 返回的 jobid。

返回

类型	描述
Promise<MapImageLayer>	解析为 MapImageLayer 实例的 promise。

示例

// Get the resulting map image layer from a completed geoprocessing job.
jobInfo.fetchResultMapImageLayer(jobInfo.jobId)).then(function(layer){
  view.map.add(layer);
});

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。

waitForJobCompletion(options){Promise<JobInfo>}

在异步作业完成时解析。可以选择监控作业进度。

参数

规范

options Object optional 选项。有关对象规范，请参阅以下属性。 规范 interval Object optional 默认值：1000 远程作业状态请求之间的时间 (以毫秒为单位)。 signal Object optional AbortSignal 允许取消异步作业。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。 statusCallback Object optional 以指定间隔调用的回调函数。使用此方法监控作业状态和消息。

返回

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

示例

// Submit an asynchronous geoprocessing job. Display the remote job status every 1.5 seconds.
// When the job has completed, the output is a MapImageLayer.
const startDate = "1998-01-01 00:00:00";
const endDate = "1998-05-31 00:00:00";
const params = {
  query: "(Date >= date '" + startDate + "' and Date <= date '" + endDate + "')"
};

const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/911CallsHotspot/GPServer/911%20Calls%20Hotspot";

submitJob(url, params).then((jobInfo) => {
  const jobid = jobInfo.jobId;
  console.log("GeoScene Server job ID: ", jobid);

  const options = {
    interval: 1500,
    statusCallback: (j) => {
      console.log("Job Status: ", j.jobStatus);
    }
  };

  jobInfo.waitForJobCompletion(options).then(() => {
    const layer = jobInfo.fetchResultMapImageLayer();
    map.add(layer);
  });
});