CreateFeaturesWorkflow

属性概述

属性详细信息

createFeatureState Stringreadonly

表示创建时的当前要素状态。此状态是：1) 在创建新要素时；2) 在 "creating-features” 步骤中更新待处理要素。

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

默认值："create-new"

data CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowDatareadonly inherited

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

declaredClass Stringreadonly inherited

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

hasNextStep Booleanreadonly inherited

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

hasPreviousStep Booleanreadonly inherited

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

numPendingFeatures Numberreadonly

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

另请参阅

• pendingFeatures

pendingFeatures GraphicsCollection<GraphicsLayer>readonly

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

另请参阅

• numPendingFeatures

started Booleanreadonly inherited

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

默认值：false

stepId Stringreadonly inherited

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

type Stringreadonly inherited

指示工作流类型的值。

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

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

可能值："create"|"create-features"|"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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

cancel(options){Promise<void>}inherited

取消活动的工作流。

参数

规范

options Object optional 具有以下属性的对象。 规范 error Error optional 返回的 Error 对象。 force Boolean optional 指示是否强制取消活动工作流。 notify Boolean optional 指示是否显示取消活动工作流的提示。

返回

类型	描述
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>	在启动活动工作流时解析。

updatePendingFeature(feature){Promise<void>}

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

参数

feature Graphic 待更新的挂起要素。

返回

类型	描述
Promise<void>	当成功将待处理要素移动到更新模式时解决。