Class GraphOutputNode

Hierarchy

GraphInterfaceNode<{ name: string; placeholder: any }, { output: any }>
- GraphOutputNode

Index

Constructors

constructor

new GraphOutputNode(): GraphOutputNode
Returns GraphOutputNode
Inherited from GraphInterfaceNode<{ name: string; placeholder: any }, { output: any }>.constructor
- Defined in core/src/graphInterface.ts:22

Properties

`Protected`_title

_title: string = ""

calculate

calculate: CalculateFunction<{ placeholder: any }, { output: any }> = ...

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

Param: inputs

Values of all input interfaces

Param: globalValues

Set of values passed to every node by the engine plugin

Returns

Values for output interfaces

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>;
} = ...

`Protected` `Optional`graphInstance

graphInstance?: Graph

graphInterfaceId

graphInterfaceId: string

hooks

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

id

id: string = ...

Unique identifier of the node

inputs

inputs: { name: NodeInterface<string>; placeholder: NodeInterface<undefined> } = ...

outputs

outputs: { output: NodeInterface<undefined> } = ...

`Readonly`type

type: "__baklava_SubgraphOutputNode" = GRAPH_OUTPUT_NODE_TYPE

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
Inherited from GraphInterfaceNode.graph
- Defined in core/src/node.ts:74

title

get title(): string
Customizable display name of the node.

Returns string
Inherited from GraphInterfaceNode.title
- Defined in core/src/node.ts:79
set title(v: string): void
Parameters
- v: string
Returns void
Inherited from GraphInterfaceNode.title
- Defined in core/src/node.ts:82

Methods

`Protected`addInput

addInput(key: string, input: NodeInterface): boolean
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)
Inherited from GraphInterfaceNode.addInput
- Defined in core/src/node.ts:95

`Protected`addOutput

addOutput(key: string, output: NodeInterface): boolean
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)
Inherited from GraphInterfaceNode.addOutput
- Defined in core/src/node.ts:105

`Protected`initializeIo

initializeIo(): void
Returns void
Inherited from GraphInterfaceNode.initializeIo
- Defined in core/src/node.ts:178

load

load(
    state: IGraphInterfaceNodeState<
        { name: string; placeholder: any },
        { output: any },
    >,
): void
Parameters
- state: IGraphInterfaceNodeState<{ name: string; placeholder: any }, { output: any }>
Returns void
Inherited from GraphInterfaceNode.load
- Defined in core/src/graphInterface.ts:39

onDestroy

onDestroy(): void
Override this method to perform cleanup when the node is deleted

Returns void
Inherited from GraphInterfaceNode.onDestroy
- Defined in core/src/node.ts:176

onPlaced

onPlaced(): void
Override this method to execute logic when the node is placed inside a graph

Returns void
Inherited from GraphInterfaceNode.onPlaced
- Defined in core/src/graphInterface.ts:27

registerGraph

registerGraph(graph: Graph): void
This function will automatically be called as soon as the node is added to a graph.
Parameters
- graph: Graph
Returns void
Inherited from GraphInterfaceNode.registerGraph
- Defined in core/src/node.ts:129

`Protected`removeInput

removeInput(key: string): boolean
Remove an existing input
Parameters
- key: string
  Key of the input.
Returns boolean
Inherited from GraphInterfaceNode.removeInput
- Defined in core/src/node.ts:113

`Protected`removeOutput

removeOutput(key: string): boolean
Remove an existing output
Parameters
- key: string
  Key of the output.
Returns boolean
Inherited from GraphInterfaceNode.removeOutput
- Defined in core/src/node.ts:121

save

save(): IGraphInterfaceNodeState<
{ name: string; placeholder: any },
{ output: any },
>
Returns IGraphInterfaceNodeState<{ name: string; placeholder: any }, { output: any }>
Inherited from GraphInterfaceNode.save
- Defined in core/src/graphInterface.ts:32

`Static`isGraphOutputNode

isGraphOutputNode(v: AbstractNode): v is GraphOutputNode
Parameters
- v: AbstractNode
Returns v is GraphOutputNode
- Defined in core/src/graphInterface.ts:61

Class GraphOutputNode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GraphOutputNode

Properties

Protected_title

calculate

Param: inputs

Param: globalValues

Returns

events

Protected OptionalgraphInstance

graphInterfaceId

hooks

id

inputs

outputs

Readonlytype

Accessors

graph

Returns undefined | Graph

title

Returns string

Parameters

Returns void

Methods

ProtectedaddInput

Parameters

Returns boolean

ProtectedaddOutput

Parameters

Returns boolean

ProtectedinitializeIo

Returns void

load

Parameters

Returns void

onDestroy

Returns void

onPlaced

Returns void

registerGraph

Parameters

Returns void

ProtectedremoveInput

Parameters

Returns boolean

ProtectedremoveOutput

Parameters

Returns boolean

save

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

StaticisGraphOutputNode

Parameters

Returns v is GraphOutputNode

Settings

On This Page

`Protected`_title

`Protected` `Optional`graphInstance

`Readonly`type

`Protected`addInput

`Protected`addOutput

`Protected`initializeIo

`Protected`removeInput

`Protected`removeOutput

`Static`isGraphOutputNode