Class EditSketchWorkflowModel<T>

constructor

• new EditSketchWorkflowModel<T = Record<string, unknown>>(
      options: EditSketchWorkflowOptions<T>,
  ): EditSketchWorkflowModel<T>

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • options: EditSketchWorkflowOptions<T>

  Returns EditSketchWorkflowModel<T>

Readonlykind

Readonlysource

dirty

• dirty(): boolean

  Returns boolean

discard

• discard(): void

  Returns void

redo

• redo(): boolean

  Returns boolean

setId

• setId(id: FeatureId): this

  Parameters

  • id: FeatureId

  Returns this

setSketchGeometry

• setSketchGeometry(
      tool: EditSketchTool,
      geometry: Record<string, unknown> | null,
  ): this

  Parameters

  • tool: EditSketchTool
  • geometry: Record<string, unknown> | null

  Returns this

setSnapping

• setSnapping(config: Partial<SnappingConfig>): this

  Merge snapping configuration changes into the workflow.

  Parameters

  • config: Partial<SnappingConfig>

  Returns this

setValue

• setValue(fieldName: string, value: unknown): this

  Parameters

  • fieldName: string
  • value: unknown

  Returns this

setValues

• setValues(values: Partial<T>): this

  Parameters

  • values: Partial<T>

  Returns this

snappingConfig

• snappingConfig(): SnappingConfig

  Current snapping configuration (disabled unless configured).

  Returns SnappingConfig

snapshot

• snapshot(): EditSketchWorkflowSnapshot<T>

  Returns EditSketchWorkflowSnapshot<T>

stageAttachmentAdd

• stageAttachmentAdd(
      attachment: string | Blob | File,
      options?: { contentType?: string; name?: string; parentId?: FeatureId },
  ): this

  Parameters

  • attachment: string | Blob | File
  • options: { contentType?: string; name?: string; parentId?: FeatureId } = {}

  Returns this

stageAttachmentDelete

• stageAttachmentDelete(
      attachmentIds: readonly FeatureId[],
      options?: { parentId?: FeatureId },
  ): this

  Parameters

  • attachmentIds: readonly FeatureId[]
  • options: { parentId?: FeatureId } = {}

  Returns this

stageAttachmentUpdate

• stageAttachmentUpdate(
      attachmentId: FeatureId,
      attachment: string | Blob | File,
      options?: { contentType?: string; name?: string; parentId?: FeatureId },
  ): this

  Parameters

  • attachmentId: FeatureId
  • attachment: string | Blob | File
  • options: { contentType?: string; name?: string; parentId?: FeatureId } = {}

  Returns this

startSketch

• startSketch(tool: EditSketchTool): EditSketchToolCapability

  Parameters

  • tool: EditSketchTool

  Returns EditSketchToolCapability

submit

• submit(overrides?: Partial<T>): Promise<EditWorkflowSubmitResult<T>>

  Parameters

  • overrides: Partial<T> = {}

  Returns Promise<EditWorkflowSubmitResult<T>>

toolCapability

• toolCapability(tool: EditSketchTool): EditSketchToolCapability

  Parameters

  • tool: EditSketchTool

  Returns EditSketchToolCapability

tools

• tools(): readonly EditSketchToolCapability[]

  Returns readonly EditSketchToolCapability[]

undo

• undo(): boolean

  Returns boolean

validate

• validate(): EditWorkflowValidationResult

  Returns EditWorkflowValidationResult