工作流有助于管理编辑工作流的不同阶段。工作流可视为以下两种类型之一:CreateFeaturesWorkflow 和 UpdateWorkflow。如果添加单个或多个要素,则使用 CreateFeaturesWorkflow。这将取代已弃用的 CreateWorkflow。如果编辑现有要素,则可使用 UpdateWorkflow。更新工作流包括编辑几何和属性数据以及删除要素。
CreateFeaturesWorkflow 或 UpdateWorkflow 的实例可通过 Editor 或 EditorViewModel 类中的 activeWorkflow
属性进行访问。
仅当要素服务允许这些操作时,才会启用这些工作流。例如,如果要素服务仅启用以允许更新,则无法使用 API 覆盖此内容。
从版本 4.23 开始,CreateWorkflow 已弃用,请改为使用 CreateFeaturesWorkflow。
- 另请参阅
构造函数
属性概述
名称 | 类型 | 描述 | 类 |
---|---|---|---|
CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowData | 共享的工作流数据。 更多详情 | Workflow | |
String | 类的名称。 更多详情 | Accessor | |
Boolean | 此属性可指示工作流中是否有下一步。 更多详情 | Workflow | |
Boolean | 此属性可指示工作流中是否有上一步。 更多详情 | Workflow | |
Boolean | 指示工作流是否被视为活动。 更多详情 | Workflow | |
String | 工作流中当前步骤的名称。 更多详情 | Workflow | |
String | 指示工作流类型的值。 更多详情 | Workflow |
属性详细信息
-
共享的工作流数据。这可以是 CreateFeaturesWorkflowData (可使用它代替已弃用的 CreateWorkflowData) 或 UpdateWorkflowData。
-
类的名称。声明的类名称格式化为
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"
方法概述
名称 | 返回值类值 | 描述 | 类 |
---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | Accessor | ||
Promise<void> | 取消活动的工作流。 更多详情 | Workflow | |
Promise<void> | 当工作流被认为完成时,调用此方法。 更多详情 | Workflow | |
Boolean | 如果存在指定的句柄组,则返回 true。 更多详情 | Accessor | |
Promise<void> | 移至工作流的下一步。 更多详情 | Workflow | |
Promise<void> | 移至工作流的上一步。 更多详情 | Workflow | |
移除对象拥有的句柄组。 更多详情 | Accessor | ||
Promise<void> | 重置工作流。 更多详情 | Workflow | |
Promise<void> | 启动工作流。 更多详情 | Workflow |
方法详细说明
-
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() 进行删除。如果未提供键,则句柄将被添加到默认组。
-
commit(){Promise<void>}起始版本:GeoScene Maps SDK for JavaScript 4.15
-
当工作流被认为完成时,调用此方法。这用于帮助处理编辑结果。
返回类型 描述 Promise<void> 在活动工作流提交和处理编辑的结果时解析。
-
起始版本: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"); }
-
previous(options){Promise<void>}
-
移至工作流的上一步。
参数options Objectoptional调用此方法时的选项。
规范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");