Class GraphInputNode

Hierarchy

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

Constructors

constructor

Properties

_title calculate? events graphInstance? graphInterfaceId hooks id inputs outputs type

Accessors

graph title

Methods

addInput addOutput initializeIo load onDestroy onPlaced registerGraph removeInput removeOutput save isGraphInputNode

Constructors

constructor

Properties

Protected_title

_title: string = ""

Optionalcalculate

calculate?: CalculateFunction<{
    name: string;
}, {
    placeholder: any;
}, 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 OptionalgraphInstance

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

outputs

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

Readonlytype

type: "__baklava_SubgraphInputNode" = GRAPH_INPUT_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

title

  • get title(): string

  • Customizable display name of the node.

    Returns string

  • set title(v): void

  • Parameters

    • v: string

    Returns void

Methods

ProtectedaddInput

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

ProtectedaddOutput

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

ProtectedinitializeIo

  • initializeIo(): void

  • Returns void

load

  • load(state): void

  • Parameters

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

    Returns void

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

ProtectedremoveInput

  • removeInput(key): boolean

  • Remove an existing input

    Parameters

    • key: string

      Key of the input.

    Returns boolean

ProtectedremoveOutput

  • removeOutput(key): boolean

  • Remove an existing output

    Parameters

    • key: string

      Key of the output.

    Returns boolean

save

  • save(): IGraphInterfaceNodeState<{
        name: string;
    }, {
        placeholder: any;
    }>

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

StaticisGraphInputNode

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods