Interface UseWorkflow

Data and methods returned by useWorkflow

Hierarchy

  • UseWorkflow

Properties

addNodeToWorkflow: ((nodeType: string) => void)

Type declaration

    • (nodeType: string): void
    • Parameters

      Returns void

addNodeToWorkflowAt: ((nodeType: string, targetId: string) => void)

Type declaration

clear: (() => void)

Type declaration

    • (): void
    • Remove the workflow including its files.

      Returns void

clearNodeSelection: (() => void)

Type declaration

    • (): void
    • Closes the form for editing parameters of the selected node.

      Returns void

deleteNode: ((nodeIndex: number) => void)

Type declaration

    • (nodeIndex: number): void
    • Parameters

      • nodeIndex: number

        The index in nodes

      Returns void

editingGlobal: boolean

Whether the form for global parameters is open

global: IParameters
loadWorkflowArchive: ((archiveURL: string) => Promise<void>)

Type declaration

    • (archiveURL: string): Promise<void>
    • Load a workflow from an archive.

      Parameters

      • archiveURL: string

        The URL can have blob or data scheme to workaround cross-origin problems.

      Returns Promise<void>

moveNode: ((sourceId: string, targetId: string) => void)

Type declaration

nodes: IWorkflowNode[]
save: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Creates archive from workflow and make web browser save it to disk.

      Returns Promise<void>

selectGlobalEdit: (() => void)

Type declaration

    • (): void
    • Returns void

selectNode: ((nodeIndex: number) => void)

Type declaration

    • (nodeIndex: number): void
    • Select a node so its parameters are rendered in a form.

      Parameters

      • nodeIndex: number

        The index in nodes

      Returns void

setEditingGlobal: ((editing: boolean) => void)

Type declaration

    • (editing: boolean): void
    • Parameters

      • editing: boolean

      Returns void

Generated using TypeDoc