Reference - BaklavaJS
    Preparing search index...

    Class DynamicNode<I, O>Abstract Internal

    Abstract base class for every dynamic node

    Type Parameters

    • I
    • O

    Hierarchy (View Summary)

    • Node<Dynamic<I>, Dynamic<O>>
      • DynamicNode
    Index
    constructor
    _title calculate? events graphInstance? hooks id inputs outputs type
    graph title
    addInput addOutput initializeIo load onDestroy onPlaced registerGraph removeInput removeOutput save

    Protected_title

    _title: string = ""
    calculate?: CalculateFunction<Dynamic<I>, Dynamic<O>>

    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

    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
    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: NodeInterfaceDefinition<Dynamic<I>>
    outputs: NodeInterfaceDefinition<Dynamic<O>>
    type: string

    Type of the node

    • 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

    • 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)

    • Override this method to execute logic when the node is placed inside a 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods