UpdateWorkflow

一个只读类，包含使用 Editor 微件更新和/或删除要素时使用的逻辑。

更新单个要素

以下阶段描述了编辑单个要素。

阶段	编辑单个要素示例
1 - 选择要编辑的要素后，初始面板包含 UpdateWorkflowData.viewModel。
2 - 选择要素后，后续属性面板可以访问 UpdateWorkflowData.edits、UpdateWorkflowData.editableItem 和 UpdateWorkflowData.viewModel。

更新多个要素

以下阶段描述了编辑多个要素。

阶段	编辑多个要素示例
1 - 选择 (ovelapped) 要编辑的要素后，初始面板包含 UpdateWorkflowData.viewModel。
2 - 如果选择了多个要素，则后续属性面板可以访问 UpdateWorkflowData.candidates 和 UpdateWorkflowData.viewModel。
3 - 选择要素后，后续属性面板可以访问 UpdateWorkflowData.edits、UpdateWorkflowData.editableItem 和 UpdateWorkflowData.viewModel。

仅当要素服务允许此操作时，才会启用此工作流。

另请参阅

• Editor
• Workflow
• CreateWorkflow
• UpdateWorkflowData

• 指南主题：微件 viewModel 模式

• 示例 - 使用编辑器微件编辑要素

• 示例 - 在 3D 模式中使用编辑器微件编辑要素

• 示例 - 具有配置的编辑器微件

• 示例 - 具有编辑操作的弹出窗口

属性概述

属性详细信息

data CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowDatareadonly inherited

共享的工作流数据。这可以是 CreateFeaturesWorkflowData (可使用它代替已弃用的 CreateWorkflowData) 或 UpdateWorkflowData。

declaredClass Stringreadonly inherited

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

hasNextStep Booleanreadonly inherited

此属性可指示工作流中是否有下一步。

hasPreviousStep Booleanreadonly inherited

此属性可指示工作流中是否有上一步。

started Booleanreadonly inherited

指示工作流是否被视为活动。

默认值：false

stepId Stringreadonly inherited

工作流中当前步骤的名称。

type Stringreadonly

工作流的类型。

对于 UpdateWorkflow，类型总是 "update"。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

cancel(){Promise<void>}inherited

取消活动的工作流。

返回

类型	描述
Promise<void>	在取消活动工作流时解析。

commit(){Promise<void>}inherited

当工作流被认为完成时，调用此方法。这用于帮助处理编辑结果。

返回

类型	描述
Promise<void>	在活动工作流提交和处理编辑的结果时解析。

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");
}

next(){Promise<void>}inherited

移至工作流的下一步。

返回

类型	描述
Promise<void>	移至活动工作流中的下一步时解析。

previous(options){Promise<void>}inherited

移至工作流的上一步。

参数

options Object optional 调用此方法时的选项。 规范 cancelCurrentStep Boolean 调用此方法时，取消当前工作流。默认值为 false。

返回

类型	描述
Promise<void>	移至活动工作流中的上一步时解析。

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");

reset(){Promise<void>}inherited

重置工作流。

返回

类型	描述
Promise<void>	在重置活动工作流时解析。

start(){Promise<void>}inherited

启动工作流。

返回

类型	描述
Promise<void>	在启动活动工作流时解析。