Reference - BaklavaJS
    Preparing search index...

    Class SubgraphOutputNode

    Hierarchy

    • GraphOutputNode
      • SubgraphOutputNode
    Index

    Constructors

    constructor

    Properties

    _title calculate disablePointerEvents events graphInstance? graphInterfaceId hooks id inputs outputs position reverseY? twoColumn type width

    Accessors

    graph title

    Methods

    addInput addOutput initializeIo load onDestroy onPlaced registerGraph removeInput removeOutput save isGraphOutputNode

    Constructors

    Properties

    Protected_title

    _title: string = "Subgraph Output"
    calculate: CalculateFunction<{ placeholder: any }, { output: any }>

    The default implementation does nothing. Overwrite this method to do calculation.

    Values of all input interfaces

    Set of values passed to every node by the engine plugin

    Values for output interfaces

    disablePointerEvents: boolean
    events: {
        addInput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
        addOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
        beforeAddInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>;
        beforeAddOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>;
        beforeRemoveInput: PreventableBaklavaEvent<
            NodeInterface<any>,
            AbstractNode,
        >;
        beforeRemoveOutput: PreventableBaklavaEvent<
            NodeInterface<any>,
            AbstractNode,
        >;
        beforeTitleChanged: PreventableBaklavaEvent<string, AbstractNode>;
        loaded: BaklavaEvent<AbstractNode, AbstractNode>;
        removeInput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
        removeOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>;
        titleChanged: BaklavaEvent<string, AbstractNode>;
        update: BaklavaEvent<INodeUpdateEventData | null, AbstractNode>;
    }
    graphInstance?: Graph
    graphInterfaceId: string
    hooks: {
        afterSave: SequentialHook<
            INodeState<any, any>,
            AbstractNode,
            INodeState<any, any>,
        >;
        beforeLoad: SequentialHook<
            INodeState<any, any>,
            AbstractNode,
            INodeState<any, any>,
        >;
    }
    id: string

    Unique identifier of the node

    inputs: { name: TextInputInterface; placeholder: NodeInterface<undefined> } = ...
    outputs: { output: NodeInterface<undefined> } = ...
    position: { x: number; y: number }
    reverseY?: boolean
    twoColumn: boolean
    type: "__baklava_SubgraphOutputNode"

    Type of the node

    width: number

    Accessors

    • get graph(): Graph | undefined

      The graph instance the node is placed in. undefined if the node hasn't been placed in a graph yet.

      Returns Graph | undefined

    • get title(): string

      Customizable display name of the node.

      Returns string

    • set title(v: string): void

      Parameters

      • v: string

      Returns void

    Methods

    • Add an input interface to the node

      Parameters

      • key: string

        Key of the input

      • input: NodeInterface

        The input instance

      Returns boolean

      True when the input was added, otherwise false (prevented by an event handler)

    • Add an output interface to the node

      Parameters

      • key: string

        Key of the output

      • output: NodeInterface

        The output instance

      Returns boolean

      True when the output was added, otherwise false (prevented by an event handler)

    • Returns void

    • Parameters

      • state: IGraphInterfaceNodeState<{ name: string; placeholder: any }, { output: any }>

      Returns void

    • Override this method to perform cleanup when the node is deleted

      Returns void

    • Override this method to execute logic when the node is placed inside a graph

      Returns void

    • This function will automatically be called as soon as the node is added to a graph.

      Parameters

      • graph: Graph

      Returns void

    • Remove an existing input

      Parameters

      • key: string

        Key of the input.

      Returns boolean

    • Remove an existing output

      Parameters

      • key: string

        Key of the output.

      Returns boolean

    • Returns IGraphInterfaceNodeState<{ name: string; placeholder: any }, { output: any }>

    • Parameters

      • v: AbstractNode

      Returns v is GraphOutputNode

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods