创建要素工作流

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

只读类,包含使用编辑器微件创建要素时使用的逻辑。

以下阶段描述了使用此工作流程添加新要素。

create-feature

步骤 添加要素
1 - 第一个面板包含 CreateFeaturesWorkflowData.viewModel create-feature-panel
2 - 选择模板后,下一个面板可以访问  CreateFeaturesWorkflowData.creationInfo 和 CreateFeaturesWorkflowData.viewModel stage2
3 - 一旦指定了要素几何,随后的属性面板就可以访问 CreateFeaturesWorkflowData.creationInfoCreateWorkflowData.viewModel 以及待定要素的数量和实际待定要素 stage3

如果该服务允许此操作,则只启用此工作流。

另阅:

属性概述

可以设置、检索或收听任何属性。 请参阅使用属性主题。
展示继承属性 隐藏继承的属性
名称 类型 总结
String更多信息

表示在创建当前要素状态。

更多信息CreateFeaturesWorkflow
CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowData更多信息

共享的工作流数据。

更多信息Workflow
String更多信息

类名称。

更多信息Accessor
Boolean更多信息

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

更多信息Workflow
Boolean更多信息

此属性表示工作流中是否存在上一步。

更多信息Workflow
Number更多信息

返回活动 CreateWorkflow 的待处理要素的数量。

更多信息CreateFeaturesWorkflow
Collection<Graphic>更多信息

返回表示活动 CreateWorkflow 中当前待处理要素的图形集合。

更多信息CreateFeaturesWorkflow
Boolean更多信息

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

更多信息Workflow
String更多信息

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

更多信息Workflow
String更多信息

表示工作流类型的值。

更多信息Workflow

属性详述

createFeatureState String

表示创建过程中的当前要素状态。 此状态是:1) 在创建新要素时; 2) 在“创建要素”步骤中更新待处理要素。

可能值:"create-new"|"update-pending"

默认值:"create-new"

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

declaredClass Stringreadonly inherited

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

hasNextStep Booleanreadonly inherited

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

hasPreviousStep Booleanreadonly inherited

此属性表示工作流中是否存在上一步。

numPendingFeatures Number

返回活动 CreateWorkflow 的待处理要素的数量。 如果没有工作流处于活动状态或工作流类型不匹配,则返回 0(零)。

另见:
pendingFeatures Collection<Graphic>

返回表示活动 CreateWorkflow 中当前待处理的图形集合。

另参阅:
started Booleanreadonly inherited

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

默认值:false
stepId Stringreadonly inherited

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

type Stringreadonly inherited

表示工作流类型的值。

可能值 描述
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
Promise<void>更多信息

将待处理的要素移动到更新模式。

更多信息CreateFeaturesWorkflow

方法详述

cancel(){Promise<void>}inherited

取消活动的工作流程。

返回:
类型 描述
Promise<void> 在取消活动工作流时解决。
commit(){Promise<void>}inherited

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

返回:
类型 描述
Promise<void> 解决活动工作流何时提交和处理编辑的结果。

移至工作流程的下一步。

返回:
类型 描述
Promise<void> 移至活动工作流程中的下一步时解决。

移至工作流程中的上一步。

参数:
options Object
optional

调用此方法时的选项。

详述:
cancelCurrentStep Boolean

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

返回:
类型 描述
Promise<void> 当移至活动工作流中的上一步时解决。
reset(){Promise<void>}inherited

重置工作流。

返回:
类型 描述
Promise<void> 在重置活动工作流时解决。
start(){Promise<void>}inherited

启动工作流程。

返回:
类型 描述
Promise<void> 解决活动工作流何时开始。
updatePendingFeature(feature){Promise<void>}

将待处理的要素移动到更新模式。

参数:
feature Graphic

待更新的要素。

返回:
类型 描述
Promise<void> 当成功将挂起的要素移动到更新模式时解决。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.