UpdateWorkflow

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

更新单个要素

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

阶段	编辑单个要素示例
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
• 工作流
• 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"。

方法概述

方法详细信息

cancel(){Promise<void>}inherited

取消活动工作流。

返回：

类型	说明
Promise<void>	取消活动工作流后解析。

commit(){Promise<void>}inherited

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

返回：

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

next(){Promise<void>}inherited

移动到工作流中的下一步。

返回：

类型	说明
Promise<void>	在活动工作流中移动到下一步时解决。

previous(options){Promise<void>}inherited

移动到工作流中的上一步。

参数：

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

返回：

类型	说明
Promise<void>	在活动工作流中移动到上一步时解决。

reset(){Promise<void>}inherited

重置工作流。

返回：

类型	说明
Promise<void>	重置活动工作流时解析。

start(){Promise<void>}inherited

启动工作流。

返回：

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