A graph editor for visual programming.

A low level class that manages nodes and connections.

Hierarchy

Constructors

Properties

__scope: {
    parents: [];
    produces: Root<Schemes>;
}
clearing: boolean = ...
connectionsMap: SvelteMap<string, 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>>>> = ...
factory?: NodeFactory
id: string = ...
name: "Node Editor" = 'Node Editor'
nameStore: Readable<string> = ...
nodesMap: SvelteMap<string, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>> = ...
onChangeNameListeners: ((name: string) => void)[] = []
parent?: any
previewedNodes: SvelteSet<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>> = ...
selectedInputs: {
    node: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>;
    selected: [string, Input<Socket<SocketType, "scalar" | "array">>][];
}[] = ...
selectedOutputs: {
    node: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>;
    selected: [string, Output<Socket<SocketType, "scalar" | "array">>][];
}[] = ...
signal: Signal<any>
variables: Record<string, Variable> = ...

Accessors

Methods

  • Parameters

    Returns void

  • Type Parameters

    Parameters

    • context: C

    Returns Promise<
        | undefined
        | Extract<{
            type: "clear";
        }, C>
        | Extract<{
            type: "clearcancelled";
        }, C>
        | Extract<{
            type: "cleared";
        }, C>
        | Extract<{
            data: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>> & NodeBase & Node<{}, {}, {}> & DataflowNode;
            type: "nodecreate";
        }, C>
        | Extract<{
            data: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>> & NodeBase & Node<{}, {}, {}> & DataflowNode;
            type: "nodecreated";
        }, C>
        | Extract<{
            data: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>> & NodeBase & Node<{}, {}, {}> & DataflowNode;
            type: "noderemove";
        }, C>
        | Extract<{
            data: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>> & NodeBase & Node<{}, {}, {}> & DataflowNode;
            type: "noderemoved";
        }, C>
        | Extract<{
            data: 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>>> & ConnectionBase & Connection<Node<{}, {}, {}>, Node<{}, {}, {}>>;
            type: "connectioncreate";
        }, C>
        | Extract<{
            data: 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>>> & ConnectionBase & Connection<Node<{}, {}, {}>, Node<{}, {}, {}>>;
            type: "connectioncreated";
        }, C>
        | Extract<{
            data: 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>>> & ConnectionBase & Connection<Node<{}, {}, {}>, Node<{}, {}, {}>>;
            type: "connectionremove";
        }, C>
        | Extract<{
            data: 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>>> & ConnectionBase & Connection<Node<{}, {}, {}>, Node<{}, {}, {}>>;
            type: "connectionremoved";
        }, C>>

  • Returns boolean

  • Type Parameters

    • T extends undefined
    • P extends []

    Returns Scope<T, P>

  • Type Parameters

    • T

    Parameters

    • type: Type<T>

    Returns T

  • Remove a connection

    Parameters

    • id: string

      The connection id

    Returns Promise<boolean>

    Whether the connection was removed

    If the connection cannot be found

    connectionremove

    connectionremoved

  • Remove a connection

    Parameters

    Returns Promise<boolean>

    Whether the connection was removed

    If the connection cannot be found

    connectionremove

    connectionremoved

  • Remove a node

    Parameters

    • id: string

      The node id

    Returns Promise<boolean>

    Whether the node was removed

    If the node cannot be found

    noderemove

    noderemoved

  • Remove a node

    Parameters

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

    Returns Promise<boolean>

    Whether the node was removed

    If the node cannot be found

    noderemove

    noderemoved

  • Parameters

    • scope: Scope<undefined, []>

    Returns void

  • Returns {
        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[];
    }

    • 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[]
  • Type Parameters

    • S extends Scope<any, any[]>

    Parameters

    Returns {
        debug<T>(_f: ((p: {
            [K in string | number | symbol]: Root<Schemes>
        }) => T)): void;
    }

    • debug:function
      • Type Parameters

        • T extends []

        Parameters

        • _f: ((p: {
              [K in string | number | symbol]: Root<Schemes>
          }) => T)
            • (p): T
            • Parameters

              • p: {
                    [K in string | number | symbol]: Root<Schemes>
                }

              Returns T

        Returns void