Class EditSketchWorkflowModel<T>

constructor

• new EditSketchWorkflowModel<T>(options): 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): this

• Parameters

  • id: FeatureId

  Returns this

setSketchGeometry

• setSketchGeometry(tool, geometry): this

• Parameters

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

  Returns this

setSnapping

• setSnapping(config): this

• Merge snapping configuration changes into the workflow.

  Parameters

  • config: Partial<SnappingConfig>

  Returns this

setValue

• setValue(fieldName, value): this

• Parameters

  • fieldName: string
  • value: unknown

  Returns this

setValues

• setValues(values): 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, options?): this

• Parameters

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

    • OptionalcontentType?: string

    • Optionalname?: string

    • OptionalparentId?: FeatureId

  Returns this

stageAttachmentDelete

• stageAttachmentDelete(attachmentIds, options?): this

• Parameters

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

    • OptionalparentId?: FeatureId

  Returns this

stageAttachmentUpdate

• stageAttachmentUpdate(attachmentId, attachment, options?): this

• Parameters

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

    • OptionalcontentType?: string

    • Optionalname?: string

    • OptionalparentId?: FeatureId

  Returns this

startSketch

• startSketch(tool): EditSketchToolCapability

• Parameters

  • tool: EditSketchTool

  Returns EditSketchToolCapability

submit

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

• Parameters

  • overrides: Partial<T> = {}

  Returns Promise<EditWorkflowSubmitResult<T>>

toolCapability

• toolCapability(tool): EditSketchToolCapability

• Parameters

  • tool: EditSketchTool

  Returns EditSketchToolCapability

tools

• tools(): readonly EditSketchToolCapability[]

• Returns readonly EditSketchToolCapability[]

undo

• undo(): boolean

• Returns boolean

validate

• validate(): EditWorkflowValidationResult

• Returns EditWorkflowValidationResult