Class NodeFactory

constructor

• new NodeFactory(params): NodeFactory

• Parameters

  • params: {
        accumulating?: {
            active(): boolean;
            destroy(): void;
        };
        area?: AreaPlugin<Schemes, AreaExtra>;
        arrange?: AutoArrangePlugin<Schemes, never>;
        comment?: CommentPlugin<Schemes, AreaExtra>;
        editor: NodeEditor;
        history?: HistoryPlugin<Schemes>;
        makutuClasses?: MakutuClassRepository;
        xmlSchemas?: Record<string, undefined | XmlSchema>;
    }

    • Optionalaccumulating?: {
          active(): boolean;
          destroy(): void;
      }

      • active:function

        • active(): boolean

        • Returns boolean

      • destroy:function

        • destroy(): void

        • Returns void

    • Optionalarea?: AreaPlugin<Schemes, AreaExtra>

    • Optionalarrange?: AutoArrangePlugin<Schemes, never>

    • Optionalcomment?: CommentPlugin<Schemes, AreaExtra>

    • editor: NodeEditor

    • Optionalhistory?: HistoryPlugin<Schemes>

    • OptionalmakutuClasses?: MakutuClassRepository

    • OptionalxmlSchemas?: Record<string, undefined | XmlSchema>

  Returns NodeFactory

Optionalarrange

codeIntegration

comment

components

ReadonlyconnectionPathType

OptionalconnectionPlugin

dataflowCache

ReadonlydataflowEngine

editor

effetRootCleanup

history

id

OptionallastAddedNode

lastSearchNodeIndex

lastSelectedNode

layout

Optional ReadonlymakutuClasses

minimapEnabled

modalStore

notifications

ReadonlypythonDataflowEngine

reactivateDataflowTimeout

search

selector

surfaceRect

transform

area

• get area(): undefined | AreaPlugin<Schemes, AreaExtra>

• Returns undefined | AreaPlugin<Schemes, AreaExtra>

• set area(area): void

• Parameters

  • area: undefined | AreaPlugin<Schemes, AreaExtra>

  Returns void

connections

• get connections(): Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]

• Connections in the editor.

  Returns Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]

nodes

• get nodes(): GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]

• Nodes in the editor.

  Returns GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]

previewedNodes

• get previewedNodes(): SvelteSet<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>

• Returns SvelteSet<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>

selection

• get selection(): NodeSelection

• Returns NodeSelection

storage

• get storage(): NodeStorage

• Returns NodeStorage

xmlSchemas

• get xmlSchemas(): SvelteMap<string, XmlSchema>

• Returns SvelteMap<string, XmlSchema>

addComponentByClass

• addComponentByClass<P, C>(componentClass, params): C

• Type Parameters

  • P extends Record<string, unknown>
  • C extends BaseComponent<ComponentSupportInterface>

  Parameters

  • componentClass: (new (params: P) => C)
    • • new (params): C

      • Parameters

        • params: P

        Returns C

  • params: Omit<P, "owner">

  Returns C

addNode

• addNode<T, Params>(nodeClass, params?): Promise<T>

• Type Parameters

  • T extends GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>
  • Params = Record<string, unknown>

  Parameters

  • nodeClass: (new (params: Params) => T)
    • • new (params): T

      • Parameters

        • params: Params

        Returns T

  • params: WithoutFactory<Params> = ...

  Returns Promise<T>

addNodes

• addNodes(nodes): Promise<void>

• Parameters

  • nodes: (GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>> | NodeSaveData)[]

  Returns Promise<void>

bulkOperation

• bulkOperation(callback): Promise<void>

• Executes callback without running dataflow engines.

  It is useful to execute multiple operations without unnecessarily running dataflow engines.

  Parameters

  • callback: (() => void | Promise<void>)

    Callback to execute

    • • (): void | Promise<void>

      • Returns void | Promise<void>

  Returns Promise<void>

centerView

• centerView(nodes?): undefined | Promise<void>

• Moves the view to the center of the nodes, with a zoom such that all nodes are visible.

  Parameters

  • Optionalnodes: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]

    Nodes to center the view on. If not provided, all nodes are used.

  Returns undefined | Promise<void>

clear

• clear(): Promise<void>

• Removes all nodes and connections from the editor.

  Returns Promise<void>

commentSelectedNodes

• commentSelectedNodes(params?): void

• Parameters

  • params: {
        text?: string;
    } = {}

    • Optionaltext?: string

  Returns void

create

• create<T>(type): T

• Type Parameters

  • T extends GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

  Parameters

  • type: (new () => T)
    • • new (): T

      • Returns T

  Returns T

deleteSelectedElements

• deleteSelectedElements(): Promise<void>

• Delete all selected elements

  Returns Promise<void>

destroy

• destroy(): void

• Returns void

destroyArea

• destroyArea(): void

• Returns void

disable

• disable(): void

• Returns void

downloadGraph

• downloadGraph(): void

• Returns void

enable

• enable(): void

• Returns void

findNode

• findNode(query): undefined | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

• Finds a node whose label or name matches the query. Repeated calls will cycle through the nodes.

  Parameters

  • query: string

  Returns undefined | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

  found node or undefined

focusNode

• focusNode(node?): void

• Parameters

  • Optionalnode: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

  Returns void

focusNodes

• focusNodes(nodes?, options?): void

• Parameters

  • Optionalnodes: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]
  • options: Params = {}

  Returns void

getArea

• getArea(): undefined | AreaPlugin<Schemes, AreaExtra>

• Returns undefined | AreaPlugin<Schemes, AreaExtra>

getControlFlowEngine

• getControlFlowEngine(): ControlFlowEngine<Schemes>

• Returns ControlFlowEngine<Schemes>

getEditor

• getEditor(): NodeEditor

• Returns NodeEditor

getNode

• getNode(id): undefined | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

• Parameters

  • id: string

  Returns undefined | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

getNodes

• getNodes(): GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]

• Returns GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]

getState

• getState<T>(id, key, initial?): T

• Type Parameters

  • T

  Parameters

  • id: string
  • key: string
  • Optionalinitial: T

  Returns T

loadFromFile

• loadFromFile(): void

• Returns void

loadGraph

• loadGraph(editorSaveData): Promise<void>

• Loads a graph from a save.

  Parameters

  • editorSaveData: {
        comments: {
            id: string;
            links: string[];
            text: string;
        }[];
        connections: ConnectionSaveData[];
        editorName: string;
        graphName: string;
        id: undefined | string;
        nodes: NodeSaveData[];
        previewedNodes: string[];
        variables: Record<string, Variable> | Variable[];
    }

    Save data to load.

    • comments: {
          id: string;
          links: string[];
          text: string;
      }[]

    • connections: ConnectionSaveData[]

    • editorName: string

    • graphName: string

    • id: undefined | string

    • nodes: NodeSaveData[]

    • previewedNodes: string[]

    • variables: Record<string, Variable> | Variable[]

  Returns Promise<void>

loadNode

• loadNode(nodeSaveData): Promise<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>

• Parameters

  • nodeSaveData: NodeSaveData

  Returns Promise<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>

openGraphForm

• openGraphForm(defaultName?): Promise<void>

• Parameters

  • defaultName: string = 'New Graph'

  Returns Promise<void>

removeNode

• removeNode(target): Promise<void>

• Removes a node from the editor, as well as its connections.

  Parameters

  • target: string | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

    node or node id

  Returns Promise<void>

resetDataflow

• resetDataflow(node?): Promise<void>

• Parameters

  • Optionalnode: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

  Returns Promise<void>

resetSuccessors

• resetSuccessors(node): void

• Parameters

  • node: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>

  Returns void

runDataflowEngines

• runDataflowEngines(): Promise<void>

• Returns Promise<void>

select

• select(entity, options?): void

• Parameters

  • entity: SelectorEntity
  • options: undefined | {
        accumulate?: boolean;
        pick?: boolean;
        range?: boolean;
    } = {}

  Returns void

selectAll

• selectAll(): void

• Returns void

selectConnection

• selectConnection(id): void

• Parameters

  • id: string

  Returns void

setState

• setState(id, key, value): void

• Parameters

  • id: string
  • key: string
  • value: unknown

  Returns void

unselectAll

• unselectAll(): void

• Returns void

useState

• useState<T>(id, key, value?): {
      get: (() => T);
      set: ((value: T) => void);
      value: T;
  }

• Type Parameters

  • T = unknown

  Parameters

  • id: string
  • key: string
  • Optionalvalue: T

  Returns {
      get: (() => T);
      set: ((value: T) => void);
      value: T;
  }

  • get: (() => T)

    • • (): T

      • Returns T

  • set: ((value: T) => void)

    • • (value): void

      • Parameters

        • value: T

        Returns void

  • value: T