Workflow

AMD: require(["geoscene/widgets/Editor/Workflow"], (Workflow) => { /* code goes here */ });
ESM: import Workflow from "@geoscene/core/widgets/Editor/Workflow";
类: geoscene/widgets/Editor/Workflow
继承于:Workflow Accessor
起始版本:GeoScene API for JavaScript 4.11

工作流有助于管理编辑工作流的不同阶段。工作流可以被视为以下两种类型之一:CreateFeaturesWorkflowUpdateWorkflow。如果添加单个或多个要素,则使用 CreateFeaturesWorkflow。这将取代已弃用的 CreateWorkflow。而如果编辑现有要素,则使用 UpdateWorkflow。更新工作流包括编辑几何和属性数据以及删除要素。

CreateFeaturesWorkflowUpdateWorkflow 的实例可通过 EditorEditorViewModel 类中的 activeWorkflow 属性进行访问。

仅当要素服务允许这些操作时,才会启用这些工作流。例如,如果要素服务仅启用以允许更新,则无法使用 API 覆盖此内容。

从版本 4.23 开始, CreateWorkflow 已弃用,转而使用 CreateFeaturesWorkflow

另请参阅:

构造函数

new Workflow(properties)
参数:
properties Object
optional

有关可能传递到构造函数中的所有属性的列表,请参阅属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承的属性 隐藏继承的属性
名称 类型 描述 类:
CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowData更多详情

共享工作流数据。

更多详情Workflow
String更多详情

类的名称。

更多详情Accessor
Boolean更多详情

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

更多详情Workflow
Boolean更多详情

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

更多详情Workflow
Boolean更多详情

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

更多详情Workflow
String更多详情

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

更多详情Workflow
String更多详情

指示工作流类型的值。

更多详情Workflow

属性详细信息

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

declaredClass Stringreadonly inherited

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

hasNextStep Booleanreadonly

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

hasPreviousStep Booleanreadonly

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

started Booleanreadonly

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

默认值:false
stepId Stringreadonly

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

type Stringreadonly

指示工作流类型的值。

可能值 说明
create 这允许最终用户在要素服务中创建新的单个要素。(自 4.23 起已弃用,使用 create-features 如下所述。)
create-features 这允许最终用户在要素服务中创建单个要素或连续要素。(自 4.23 起)
update 这允许最终用户更新和/或删除要素服务中的要素。

仅当要素服务允许这些操作时,才会启用这些工作流。

可能值"create"|"create-features"|"update"

方法概述

名称 返回类型 描述 类:
Promise<void>更多详情

取消活动工作流。

更多详情Workflow
Promise<void>更多详情

当工作流被视为已完成时调用此方法。

更多详情Workflow
Promise<void>更多详情

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

更多详情Workflow
Promise<void>更多详情

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

更多详情Workflow
Promise<void>更多详情

重置工作流。

更多详情Workflow
Promise<void>更多详情

启动工作流。

更多详情Workflow

方法详细信息

cancel(){Promise<void>}

取消活动工作流。

返回:
类型 说明
Promise<void> 取消活动工作流后解析。
commit(){Promise<void>}
起始版本:GeoScene API for JavaScript 4.15

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

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

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

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

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

参数:
options Object
optional

调用此方法时的选项。

规范:
cancelCurrentStep Boolean

调用此方法时取消当前工作流。默认值为 false

返回:
类型 说明
Promise<void> 在活动工作流中移动到上一步时解决。
reset(){Promise<void>}

重置工作流。

返回:
类型 说明
Promise<void> 重置活动工作流时解析。
start(){Promise<void>}

启动工作流。

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

您的浏览器不再受支持。请升级浏览器以获得最佳体验。有关更多详细信息,请参阅我们的 浏览器弃用帖子