Class NodeInterface<T>

Type Parameters

T = any

Implements

IBaklavaEventEmitter
IBaklavaTapable

Index

Constructors

constructor

new NodeInterface<T>(name, value): NodeInterface<T>
Type Parameters
- T = any
Parameters
- name: string
- value: T
Returns NodeInterface<T>
- Defined in core/src/nodeInterface.ts:78

Properties

`Optional` component

component?: any

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

events

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

Type declaration

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

hidden

hidden: boolean = false

Whether to hide the node interface in the UI

hooks

hooks: {
load: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>;
save: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>;
} = ...

Type declaration

Readonly load: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>
Readonly save: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>

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 = true

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

Accessors

connectionCount

get connectionCount(): number
Returns number
- Defined in core/src/nodeInterface.ts:62
set connectionCount(v): void
Parameters
- v: number
Returns void
- Defined in core/src/nodeInterface.ts:58

value

get value(): T
Returns T
- Defined in core/src/nodeInterface.ts:74
set value(v): void
Parameters
- v: T
Returns void
- Defined in core/src/nodeInterface.ts:67

Methods

load

load(state): void
Parameters
- state: INodeInterfaceState<T>
Returns void
- Defined in core/src/nodeInterface.ts:83

save

save(): INodeInterfaceState<T>
Returns INodeInterfaceState<T>
- Defined in core/src/nodeInterface.ts:90

setComponent

setComponent(value): this
Parameters
- value: any
Returns this
- Defined in core/src/nodeInterface.ts:99

setHidden

setHidden(value): this
Parameters
- value: boolean
Returns this
- Defined in core/src/nodeInterface.ts:109

setPort

setPort(value): this
Parameters
- value: boolean
Returns this
- Defined in core/src/nodeInterface.ts:104

use

use<A>(middleware, ...args): this
Type Parameters
- A extends any[]
Parameters
- middleware: NodeInterfaceMiddleware<T, A>
- Rest ...args: A
Returns this
- Defined in core/src/nodeInterface.ts:114

Class NodeInterface<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NodeInterface<T>

Properties

Optional component

events

Type declaration

Readonly beforeSetValue: PreventableBaklavaEvent<T, NodeInterface<T>>

Readonly setConnectionCount: BaklavaEvent<number, NodeInterface<T>>

Readonly setValue: BaklavaEvent<T, NodeInterface<T>>

Readonly updated: BaklavaEvent<void, NodeInterface<T>>

hidden

hooks

Type declaration

Readonly load: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>

Readonly save: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>

id

Optional isInput

name

nodeId

port

Optional templateId

Accessors

connectionCount

Returns number

Parameters

Returns void

value

Returns T

Parameters

Returns void

Methods

load

Parameters

Returns void

save

Returns INodeInterfaceState<T>

setComponent

Parameters

Returns this

setHidden

Parameters

Returns this

setPort

Parameters

Returns this

use

Type Parameters

Parameters

Returns this

Settings

Member Visibility

Theme

On This Page

`Optional` component

`Readonly` beforeSetValue: PreventableBaklavaEvent<T, NodeInterface<T>>

`Readonly` setConnectionCount: BaklavaEvent<number, NodeInterface<T>>

`Readonly` setValue: BaklavaEvent<T, NodeInterface<T>>

`Readonly` updated: BaklavaEvent<void, NodeInterface<T>>

`Readonly` load: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>

`Readonly` save: SequentialHook<INodeInterfaceState<T>, NodeInterface<T>, INodeInterfaceState<T>>

`Optional` isInput

`Optional` templateId