Class AbstractNodeAbstract

Hierarchy (view full)

Implements

  • IBaklavaEventEmitter
  • IBaklavaTapable

Constructors

constructor

Properties

_title calculate? events graphInstance? hooks id inputs outputs type

Accessors

graph title

Methods

addInput addOutput initializeIo load onDestroy onPlaced registerGraph removeInput removeOutput save

Constructors

constructor

Properties

Protected _title

_title: string = ""

Optional Abstract calculate

calculate?: CalculateFunction<any, any, CalculationContext<any, IEngine<any>>>

events

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<null | INodeUpdateEventData, AbstractNode>;
} = ...

Type declaration

Protected Optional graphInstance

graphInstance?: Graph

hooks

hooks: {
    afterSave: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>;
    beforeLoad: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>;
} = ...

Type declaration

id

id: string = ...

Unique identifier of the node

Abstract inputs

inputs: Record<string, NodeInterface<any>>

Abstract outputs

outputs: Record<string, NodeInterface<any>>

Readonly Abstract type

type: string

Type of the node

Accessors

graph

  • get graph(): undefined | Graph

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

    Returns undefined | Graph

title

Methods

Protected addInput

  • addInput(key, input): boolean

  • Add an input interface to the node

    Parameters

    • key: string

      Key of the input

    • input: NodeInterface<any>

      The input instance

    Returns boolean

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

Protected addOutput

  • addOutput(key, output): boolean

  • Add an output interface to the node

    Parameters

    • key: string

      Key of the output

    • output: NodeInterface<any>

      The output instance

    Returns boolean

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

Protected initializeIo

load

onDestroy

  • onDestroy(): void

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

    Returns void

onPlaced

  • onPlaced(): void

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

    Returns void

registerGraph

  • registerGraph(graph): void

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

    Parameters

    Returns void

Protected removeInput

  • removeInput(key): boolean

  • Remove an existing input

    Parameters

    • key: string

      Key of the input.

    Returns boolean

Protected removeOutput

  • removeOutput(key): boolean

  • Remove an existing output

    Parameters

    • key: string

      Key of the output.

    Returns boolean

save

Settings

Member Visibility

Theme

On This Page

constructor_titlecalculateeventsgraphInstancehooksidinputsoutputstypegraphtitleaddInputaddOutputinitializeIoloadonDestroyonPlacedregisterGraphremoveInputremoveOutputsave