Class ButtonInterface

Hierarchy

  • NodeInterface<undefined>
    • ButtonInterface

Constructors

constructor

Properties

allowMultipleConnections? callback? 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

Optional allowMultipleConnections

allowMultipleConnections?: boolean

Optional callback

callback?: (() => void)

Type declaration

    • (): void

    • Returns void

component

component: ComponentOptions = ...

Optional displayInSidebar

displayInSidebar?: boolean

events

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

Type declaration

  • Readonly beforeSetValue: PreventableBaklavaEvent<undefined, NodeInterface<undefined>>
  • Readonly setConnectionCount: BaklavaEvent<number, NodeInterface<undefined>>
  • Readonly setValue: BaklavaEvent<undefined, NodeInterface<undefined>>
  • Readonly updated: BaklavaEvent<void, NodeInterface<undefined>>

hidden

hidden: boolean

Whether to hide the node interface in the UI

hooks

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

Type declaration

  • Readonly load: SequentialHook<INodeInterfaceState<undefined>, NodeInterface<undefined>, INodeInterfaceState<undefined>>
  • Readonly save: SequentialHook<INodeInterfaceState<undefined>, NodeInterface<undefined>, INodeInterfaceState<undefined>>

id

id: string

Optional isInput

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)

Optional templateId

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

Optional type

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<undefined>

    Returns void

save

  • save(): INodeInterfaceState<undefined>

  • Returns INodeInterfaceState<undefined>

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<undefined, A>
    • Rest ...args: A

    Returns this

Settings

Member Visibility

Theme

On This Page

constructorallowMultipleConnectionscallbackcomponentdisplayInSidebareventshiddenhooksidisInputnamenodeIdporttemplateIdtypeconnectionCountvalueloadsavesetComponentsetHiddensetPortuse