Class GraphInputNode

Hierarchy

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

Index

Constructors

constructor

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

Properties

`Protected` _title

_title: string = ""

`Optional` calculate

calculate?: CalculateFunction<{
name: string;
}, {
placeholder: any;
}, CalculationContext<any, IEngine<any>>>

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

Type declaration

name: string

Type declaration

placeholder: any

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

Type declaration

Readonly addInput: BaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly addOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly beforeAddInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly beforeAddOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly beforeRemoveInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly beforeRemoveOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly beforeTitleChanged: PreventableBaklavaEvent<string, AbstractNode>
Readonly loaded: BaklavaEvent<AbstractNode, AbstractNode>
Readonly removeInput: BaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly removeOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>
Readonly titleChanged: BaklavaEvent<string, AbstractNode>
Readonly 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>>;
} = ...

Type declaration

Readonly afterSave: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>
Readonly beforeLoad: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>

id

id: string = ...

Unique identifier of the node

inputs

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

Type declaration

name: NodeInterface<string>

outputs

outputs: {
placeholder: NodeInterface<undefined>;
} = ...

Type declaration

placeholder: NodeInterface<undefined>

`Readonly` type

type: "__baklava_SubgraphInputNode" = GRAPH_INPUT_NODE_TYPE

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): void
Parameters
- v: string
Returns void
Inherited from GraphInterfaceNode.title
- Defined in core/src/node.ts:82

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

`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)
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): void
Parameters
- state: IGraphInterfaceNodeState<{
  name: string;
  }, {
  placeholder: 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
Returns void
Inherited from GraphInterfaceNode.onPlaced
- Defined in core/src/graphInterface.ts:27

registerGraph

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

`Static` isGraphInputNode

isGraphInputNode(v): v is GraphInputNode
Parameters
- v: AbstractNode
Returns v is GraphInputNode
- Defined in core/src/graphInterface.ts:46

Class GraphInputNode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GraphInputNode

Properties

Protected _title

Optional calculate

Type declaration

name: string

Type declaration

placeholder: any

Param: inputs

Param: globalValues

Returns

events

Type declaration

Readonly addInput: BaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly addOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly beforeAddInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly beforeAddOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly beforeRemoveInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly beforeRemoveOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly beforeTitleChanged: PreventableBaklavaEvent<string, AbstractNode>

Readonly loaded: BaklavaEvent<AbstractNode, AbstractNode>

Readonly removeInput: BaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly removeOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>

Readonly titleChanged: BaklavaEvent<string, AbstractNode>

Readonly update: BaklavaEvent<null | INodeUpdateEventData, AbstractNode>

Protected Optional graphInstance

graphInterfaceId

hooks

Type declaration

Readonly afterSave: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>

Readonly beforeLoad: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>

id

inputs

Type declaration

name: NodeInterface<string>

outputs

Type declaration

placeholder: NodeInterface<undefined>

Readonly type

Accessors

graph

Returns undefined | Graph

title

Returns string

Parameters

Returns void

Methods

Protected addInput

Parameters

Returns boolean

Protected addOutput

Parameters

Returns boolean

Protected initializeIo

Returns void

load

Parameters

Returns void

onDestroy

Returns void

onPlaced

Returns void

registerGraph

Parameters

Returns void

Protected removeInput

Parameters

Returns boolean

Protected removeOutput

Parameters

Returns boolean

`Protected` _title

`Optional` calculate

`Readonly` addInput: BaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` addOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` beforeAddInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` beforeAddOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` beforeRemoveInput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` beforeRemoveOutput: PreventableBaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` beforeTitleChanged: PreventableBaklavaEvent<string, AbstractNode>

`Readonly` loaded: BaklavaEvent<AbstractNode, AbstractNode>

`Readonly` removeInput: BaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` removeOutput: BaklavaEvent<NodeInterface<any>, AbstractNode>

`Readonly` titleChanged: BaklavaEvent<string, AbstractNode>

`Readonly` update: BaklavaEvent<null | INodeUpdateEventData, AbstractNode>

`Protected` `Optional` graphInstance

`Readonly` afterSave: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>

`Readonly` beforeLoad: SequentialHook<INodeState<any, any>, AbstractNode, INodeState<any, any>>

`Readonly` type

`Protected` addInput

`Protected` addOutput

`Protected` initializeIo

`Protected` removeInput

`Protected` removeOutput

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

`Static` isGraphInputNode