Class Node<I, O>`Abstract`

Abstract base class for every node

Type Parameters

Hierarchy (View Summary)

AbstractNode
- Node
  - DynamicNode

Index

Constructors

constructor

new Node<I, O>(): Node<I, O>
Type Parameters
- I
- O
Returns Node<I, O>
Inherited from AbstractNode.constructor

Properties

`Protected`_title

_title: string = ""

`Optional`calculate

calculate?: CalculateFunction<I, O, CalculationContext<any, IEngine<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

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

`Abstract`inputs

inputs: NodeInterfaceDefinition<I>

`Abstract`outputs

outputs: NodeInterfaceDefinition<O>

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

title

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

Returns string
Inherited from AbstractNode.title
- Defined in core/src/node.ts:79
set title(v: string): void
Parameters
- v: string
Returns void
Inherited from AbstractNode.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 AbstractNode.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 AbstractNode.addOutput
- Defined in core/src/node.ts:105

`Protected`initializeIo

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

load

load(state: INodeState<I, O>): void
Parameters
- state: INodeState<I, O>
Returns void
Overrides AbstractNode.load
- Defined in core/src/node.ts:242

onDestroy

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

Returns void
Inherited from AbstractNode.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 AbstractNode.onPlaced
- Defined in core/src/node.ts:170

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 AbstractNode.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 AbstractNode.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 AbstractNode.removeOutput
- Defined in core/src/node.ts:121

save

save(): INodeState<I, O>
Returns INodeState<I, O>
Overrides AbstractNode.save
- Defined in core/src/node.ts:246

Class Node<I, O>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns Node<I, O>

Properties

Protected_title

Optionalcalculate

Param: inputs

Param: globalValues

Returns

events

Protected OptionalgraphInstance

hooks

id

Abstractinputs

Abstractoutputs

Abstract 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 INodeState<I, O>

Settings

On This Page

Class Node<I, O>`Abstract`

`Protected`_title

`Optional`calculate

`Protected` `Optional`graphInstance

`Abstract`inputs

`Abstract`outputs

`Abstract` `Readonly`type

`Protected`addInput

`Protected`addOutput

`Protected`initializeIo

`Protected`removeInput

`Protected`removeOutput