Reference - BaklavaJS
    Preparing search index...

    Class TextInputInterface

    Hierarchy

    • NodeInterface<string>
      • TextInputInterface
    Index

    Constructors

    constructor

    Properties

    allowMultipleConnections? component displayInSidebar? events hidden hooks id isInput? name nodeId port templateId? type?

    Accessors

    connectionCount value

    Methods

    load save setComponent setHidden setPort use

    Constructors

    • Parameters

      • name: string
      • value: string

      Returns TextInputInterface

    Properties

    allowMultipleConnections?: boolean
    component: ComponentOptions = ...

    The component which will be displayed when the interface is not connected or port === false

    displayInSidebar?: boolean
    events: {
        beforeSetValue: PreventableBaklavaEvent<string, NodeInterface<string>>;
        setConnectionCount: BaklavaEvent<number, NodeInterface<string>>;
        setValue: BaklavaEvent<string, NodeInterface<string>>;
        updated: BaklavaEvent<void, NodeInterface<string>>;
    }
    hidden: boolean

    Whether to hide the node interface in the UI

    hooks: {
        load: SequentialHook<
            INodeInterfaceState<string>,
            NodeInterface<string>,
            INodeInterfaceState<string>,
        >;
        save: SequentialHook<
            INodeInterfaceState<string>,
            NodeInterface<string>,
            INodeInterfaceState<string>,
        >;
    }
    id: string
    isInput?: boolean

    Will be set automatically after the node was created

    name: string

    Display name of the interface

    nodeId: string

    Id of the node this interface is part of

    port: boolean

    Whether to show the port (the thing connections connect to)

    templateId?: string

    If the interface is instantiated by a graph template, this property will be set to the id of the corresponding instance in the template

    type?: string

    Accessors

    • get connectionCount(): number

      Returns number

    • set connectionCount(v: number): void

      Parameters

      • v: number

      Returns void

    • get value(): T

      Returns T

    • set value(v: T): void

      Parameters

      • v: T

      Returns void

    Methods

    • Parameters

      • state: INodeInterfaceState<string>

      Returns void

    • Returns INodeInterfaceState<string>

    • Parameters

      • value: any

      Returns this

    • Parameters

      • value: boolean

      Returns this

    • Parameters

      • value: boolean

      Returns this

    • Type Parameters

      • A extends any[]

      Parameters

      • middleware: NodeInterfaceMiddleware<string, A>
      • ...args: A

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods