Class TextInterface

Hierarchy

  • NodeInterface<string>
    • TextInterface

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

constructor

Properties

OptionalallowMultipleConnections

allowMultipleConnections?: boolean

component

component: ComponentOptions = ...

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

OptionaldisplayInSidebar

displayInSidebar?: boolean

events

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

hidden

hidden: boolean

Whether to hide the node interface in the UI

hooks

hooks: {
    load: SequentialHook<INodeInterfaceState<string>, NodeInterface<string>, INodeInterfaceState<string>>;
    save: SequentialHook<INodeInterfaceState<string>, NodeInterface<string>, INodeInterfaceState<string>>;
}

id

id: string

OptionalisInput

isInput?: boolean

Will be set automatically after the node was created

name

name: string

Display name of the interface

nodeId

nodeId: string

Id of the node this interface is part of

port

port: boolean

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

OptionaltemplateId

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

Optionaltype

type?: string

Accessors

connectionCount

  • get connectionCount(): number

  • Returns number

  • set connectionCount(v): void

  • Parameters

    • v: number

    Returns void

value

  • get value(): T

  • Returns T

  • set value(v): void

  • Parameters

    • v: T

    Returns void

Methods

load

  • load(state): void

  • Parameters

    • state: INodeInterfaceState<string>

    Returns void

save

  • save(): INodeInterfaceState<string>

  • Returns INodeInterfaceState<string>

setComponent

  • setComponent(value): this

  • Parameters

    • value: any

    Returns this

setHidden

  • setHidden(value): this

  • Parameters

    • value: boolean

    Returns this

setPort

  • setPort(value): this

  • Parameters

    • value: boolean

    Returns this

use

  • use<A>(middleware, ...args): this

  • Type Parameters

    • A extends any[]

    Parameters

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

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods