Aller au contenu
Selenite Logo Selenite Logo Docs

Node

Ce contenu n’est pas encore disponible dans votre langue.

Classes

Connection<A, B>

Extends

  • Connection<A, B>

Type Parameters

• A extends Node = Node

• B extends Node = Node

Constructors

new Connection()
new Connection<A, B>(
   source,
   sourceOutput,
   target,
targetInput): Connection<A, B>
Parameters

• source: A

Source node instance

• sourceOutput: keyof A["outputs"]

Source node output key

• target: B

Target node instance

• targetInput: keyof B["inputs"]

Target node input key

Returns

Connection<A, B>

Inherited from

ClassicPreset.Connection<A, B>.constructor

Defined in

tmp/graph-editor/node_modules/rete/_types/presets/classic.d.ts:216

Properties

factory?
optional factory: NodeFactory;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1040

id
id: string;

Connection id, unique string generated by getUID function

Inherited from

ClassicPreset.Connection.id

Defined in

tmp/graph-editor/node_modules/rete/_types/presets/classic.d.ts:200

source
source: string;

Source node id

Inherited from

ClassicPreset.Connection.source

Defined in

tmp/graph-editor/node_modules/rete/_types/presets/classic.d.ts:204

sourceOutput
sourceOutput: keyof A["outputs"];
Inherited from

ClassicPreset.Connection.sourceOutput

Defined in

tmp/graph-editor/node_modules/rete/_types/presets/classic.d.ts:195

target
target: string;

Target node id

Inherited from

ClassicPreset.Connection.target

Defined in

tmp/graph-editor/node_modules/rete/_types/presets/classic.d.ts:208

targetInput
targetInput: keyof B["inputs"];
Inherited from

ClassicPreset.Connection.targetInput

Defined in

tmp/graph-editor/node_modules/rete/_types/presets/classic.d.ts:196

visible
visible: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1027

Accessors

picked
get picked(): boolean
Returns

boolean

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1037

selected
get selected(): boolean
Returns

boolean

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1033

Methods

toJSON()
toJSON(): ConnectionSaveData
Returns

ConnectionSaveData

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1042

Node<Inputs, Outputs, Controls, State, Params>

Extended by

Type Parameters

• Inputs extends Record<string, Socket> = Record<string, Socket>

• Outputs extends { [key in string]: Socket } = { [key in string]: Socket }

• Controls extends { [key in string]: Control } = { [key in string]: Control }

• State extends Record<string, unknown> = Record<string, unknown>

• Params extends Record<string, unknown> = Record<string, unknown>

Implements

Constructors

new Node()
new Node<Inputs, Outputs, Controls, State, Params>(params): Node<Inputs, Outputs, Controls, State, Params>
Parameters

• params: NodeParams = {}

Returns

Node<Inputs, Outputs, Controls, State, Params>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:404

Properties

afterInitialize()?
optional afterInitialize: () => void;
Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:376

controls
controls: Controls;

Node controls

Implementation of

ClassicPreset.Node.controls

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:349

description
description: undefined | string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:342

factory
factory: undefined | NodeFactory;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:327

inConnections
inConnections: object;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:402

inEditor
inEditor: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:323

ingoingDataConnections
readonly ingoingDataConnections: Record<string, Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>[]>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:365

ingoingExecConnections
readonly ingoingExecConnections: Record<string, Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>[]>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:366

initializePromise?
optional initializePromise: Promise<void>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:371

initialValues?
optional initialValues: object;
controls?
optional controls: Record<string, unknown>;
inputs?
optional inputs: Record<string, unknown>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:372

inputs
inputs: { [key in string | number | symbol]?: Input<Exclude<Inputs[key], undefined>> };

Node inputs

Implementation of

ClassicPreset.Node.inputs

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:343

inputTypes
inputTypes: Record<string, object>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:676

label
label: string;
Implementation of

ClassicPreset.Node.label

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:441

needsProcessing
needsProcessing: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:350

onRemoveIngoingConnection()?
optional onRemoveIngoingConnection: (conn) => void;
Parameters

• conn: Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:369

outConnections
outConnections: object;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:401

outgoingDataConnections
readonly outgoingDataConnections: Record<string, Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>[]>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:367

outgoingExecConnections
readonly outgoingExecConnections: Record<string, Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>[]>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:368

outputs
outputs: { [key in string | number | symbol]?: Output<Exclude<Outputs[key], undefined>> };

Node outputs

Implementation of

ClassicPreset.Node.outputs

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:346

outputTypes
outputTypes: Record<string, object>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:687

pos
pos: object;
x
x: number = 0;
y
y: number = 0;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:246

pythonComponent
readonly pythonComponent: PythonNodeComponent;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:363

selectedInputs
selectedInputs: [string, Input<Socket<SocketType, "scalar" | "array">>][];
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:356

selectedOutputs
selectedOutputs: [string, Output<Socket<SocketType, "scalar" | "array">>][];
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:359

socketSelectionComponent
readonly socketSelectionComponent: R_SocketSelection_NC;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:364

sortedControls
sortedControls: [string, Control][];
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:362

sortedInputs
sortedInputs: [string, Input<Socket<SocketType, "scalar" | "array">>][];
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:351

sortedOutputs
sortedOutputs: [string, Output<Socket<SocketType, "scalar" | "array">>][];
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:352

state
state: object & Partial<State>;
Type declaration
name?
optional name: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:331

visible
visible: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:273

activeFactory
static activeFactory: undefined | NodeFactory;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:321

description
static description: string = '';
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:315

id
static id: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:329

nodeCounts
static nodeCounts: number = 0;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:330

visible
static visible: boolean = true;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:316

Accessors

area
get area(): undefined | AreaPlugin<Schemes, AreaExtra>
Returns

undefined | AreaPlugin<Schemes, AreaExtra>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:307

editor
get editor(): undefined | NodeEditor
Returns

undefined | NodeEditor

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:303

height
get height(): number
set height(h): void
Parameters

• h: number

Returns

number

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:277

id
get id(): string

Node id, unique string generated by getUID function

Returns

string

Implementation of

ClassicPreset.Node.id

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:443

name
get name(): undefined | string
set name(n): void
Parameters

• n: string

Returns

undefined | string

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:332

picked
get picked(): boolean
Returns

boolean

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:465

previewed
get previewed(): boolean
set previewed(previewed): void
Parameters

• previewed: boolean

Returns

boolean

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:447

rect
get rect(): Rect
Returns

Rect

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:249

selected
get selected(): boolean

Whether the node is selected. Default is false

Returns

boolean

Implementation of

ClassicPreset.Node.selected

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:461

view
get view(): undefined | NodeView
Returns

undefined | NodeView

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:311

width
get width(): number
set width(w): void
Parameters

• w: number

Returns

number

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:274

Methods

addComponentByClass()
addComponentByClass<P, C>(componentClass, params): C
Type Parameters

• P extends Record<string, unknown>

• C extends BaseComponent<ComponentSupportInterface>

Parameters

• componentClass

• params: Omit<P, "owner">

Returns

C

Implementation of

ComponentSupportInterface.addComponentByClass

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:512

addControl()
addControl<K>(key, control): void
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

• control: Controls[K]

Returns

void

Implementation of

ClassicPreset.Node.addControl

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:489

addInData()
addInData<K>(key, params?): Input<Inputs[K]>
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

• params?

• params.alwaysShowLabel?: boolean

• params.changeType?

• params.control?: Partial<InputControlParams< | "number" | "integer" | "vector" | "remote-file" | "text" | "checkbox" | "group-name-ref" | "textarea" | "select">>

• params.datastructure?: Inputs[K]["datastructure"] extends "scalar" ? undefined | "scalar" : Inputs[K]["datastructure"]

• params.description?: string

• params.hideLabel?: boolean

• params.index?: number

• params.initial?: SocketValueType<Inputs[K]["type"]>

• params.isRequired?: boolean

• params.label?: string

• params.options?: string[]

• params.props?: HTMLInputAttributes

• params.type?: Inputs[K]["type"]

Returns

Input<Inputs[K]>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:783

addInExec()
addInExec(name, displayName): void
Parameters

• name: ExecSocketsKeys<Inputs> = ...

• displayName: string = ''

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:719

addInput()
addInput<K>(key, input): void
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

• input: Input<Exclude<Inputs[K], undefined>>

Returns

void

Implementation of

ClassicPreset.Node.addInput

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:384

addInputControl()
addInputControl<T>(key, params): InputControl<T, "scalar" | "array">
Type Parameters

• T extends | "number" | "integer" | "vector" | "remote-file" | "text" | "checkbox" | "group-name-ref" | "textarea" | "select"

Parameters

• key: keyof Controls

• params: InputControlParams<T>

Returns

InputControl<T, "scalar" | "array">

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:890

addOutData()
addOutData<K>(key, params): Socket<Outputs[K]["type"], "scalar" | Outputs[K]["datastructure"]>
Type Parameters

• K extends string

Parameters

• key: K

• params

• params.datastructure?: Outputs[K]["datastructure"]

• params.description?: string

• params.index?: number

• params.isArray?: boolean

• params.label?: string

• params.showLabel?: boolean

• params.type: Outputs[K]["type"]

Returns

Socket<Outputs[K]["type"], "scalar" | Outputs[K]["datastructure"]>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:728

addOutExec()
addOutExec(
   name,
   displayName,
   isNaturalFlow): void
Parameters

• name: ExecSocketsKeys<Outputs> = ...

• displayName: string = ''

• isNaturalFlow: boolean = false

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:903

addOutput()
addOutput<K>(key, output): void
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

• output: Output<Exclude<Outputs[K], undefined>>

Returns

void

Implementation of

ClassicPreset.Node.addOutput

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:388

applyState()
applyState(): void
Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:528

data()
data(inputs?): SocketsValues<DataSockets<Outputs>> | Promise<SocketsValues<DataSockets<Outputs>>>
Parameters

• inputs?: SocketsValues<Inputs>

Returns

SocketsValues<DataSockets<Outputs>> | Promise<SocketsValues<DataSockets<Outputs>>>

Implementation of

DataflowNode.data

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:978

deselectInput()
deselectInput(key): void
Parameters

• key: string

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:609

deselectOutput()
deselectOutput(key): void
Parameters

• key: string

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:617

emitResized()
emitResized(): Promise<void>
Returns

Promise<void>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:289

execute()
execute(
   input,
   forward,
forwardExec): void | Promise<void>
Parameters

• input: ExecSocketsKeys<Inputs>

• forward

• forwardExec: boolean = true

Returns

void | Promise<void>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:704

fetchInputs()
fetchInputs(): Promise<SocketsValues<Inputs>>
Returns

Promise<SocketsValues<Inputs>>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:629

getArea()
getArea(): undefined | AreaPlugin<Schemes, AreaExtra>
Returns

undefined | AreaPlugin<Schemes, AreaExtra>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:655

getConnections()
getConnections(): Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>[]
Returns

Connection<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>, Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>[]

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:392

getData()
getData<K>(key, inputs?): SocketValueWithDatastructure<SocketValueType<Inputs[K]["type"]>, Inputs[K]["datastructure"]>
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

• inputs?: Record<keyof Inputs, unknown>

Returns

SocketValueWithDatastructure<SocketValueType<Inputs[K]["type"]>, Inputs[K]["datastructure"]>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:945

getDataflowEngine()
getDataflowEngine(): undefined | DataflowEngine<Schemes>
Returns

undefined | DataflowEngine<Schemes>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:643

getDataWithInputs()
getDataWithInputs<K>(key): Promise<SocketValueWithDatastructure<SocketValueType<Inputs[K]["type"]>, Inputs[K]["datastructure"]>>
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

Returns

Promise<SocketValueWithDatastructure<SocketValueType<Inputs[K]["type"]>, Inputs[K]["datastructure"]>>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:936

getEditor()
getEditor(): undefined | NodeEditor
Returns

undefined | NodeEditor

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:647

getFactory()
getFactory(): undefined | NodeFactory
Returns

undefined | NodeFactory

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:378

getNaturalFlow()
getNaturalFlow(): undefined | string
Returns

undefined | string

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:625

getOutData()
getOutData(): Record<string, unknown>
Returns

Record<string, unknown>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:998

getOutgoers()
getOutgoers(key): null | Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>[]
Parameters

• key: string

Returns

null | Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>[]

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:499

getPosition()
getPosition(): undefined | object
Returns

undefined | object

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:524

getState()
getState(): Record<string, unknown>
Returns

Record<string, unknown>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:381

getWaitForChildrenPromises()
getWaitForChildrenPromises(output): Promise<void>
Parameters

• output: ExecSocketsKeys<Outputs>

Returns

Promise<void>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:698

getWaitPromises()
getWaitPromises(nodes): Promise<void>[]
Parameters

• nodes: Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>[]

Returns

Promise<void>[]

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:932

hasControl()
hasControl<K>(key): boolean
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

Returns

boolean

Implementation of

ClassicPreset.Node.hasControl

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:486

hasInput()
hasInput<K>(key): boolean
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

Returns

boolean

Implementation of

ClassicPreset.Node.hasInput

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:469

hasOutput()
hasOutput<K>(key): boolean
Type Parameters

• K extends string | number | symbol

Parameters

• key: K

Returns

boolean

Implementation of

ClassicPreset.Node.hasOutput

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:480

makeInputControl()
makeInputControl<T, D>(params): InputControl<T, "scalar" | "array">
Type Parameters

• T extends | "number" | "integer" | "vector" | "remote-file" | "text" | "checkbox" | "group-name-ref" | "textarea" | "select"

• D extends "scalar" | "array" = "scalar" | "array"

Parameters

• params: InputControlParams<T, D>

Returns

InputControl<T, "scalar" | "array">

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:875

oldAddInData()
oldAddInData<N>(__namedParameters): Input<Socket<SocketType, "scalar" | "array">>
Type Parameters

• N

Parameters

• __namedParameters: InDataParams<N>

Returns

Input<Socket<SocketType, "scalar" | "array">>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:855

oldAddOutData()
oldAddOutData(__namedParameters): void
Parameters

• __namedParameters: OutDataParams

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:762

onEndExecute()
onEndExecute(): void
Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:660

processDataflow()
processDataflow(): void
Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:917

removeControl()
removeControl(key): void
Parameters

• key: keyof Controls

Returns

void

Implementation of

ClassicPreset.Node.removeControl

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:492

removeInput()
removeInput(key): void
Parameters

• key: keyof Inputs

Returns

void

Implementation of

ClassicPreset.Node.removeInput

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:472

removeOutput()
removeOutput(key): void
Parameters

• key: keyof Outputs

Returns

void

Implementation of

ClassicPreset.Node.removeOutput

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:483

selectInput()
selectInput(key): void
Parameters

• key: string

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:605

selectOutput()
selectOutput(key): void
Parameters

• key: string

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:613

setData()
setData(key, value): void
Parameters

• key: string

• value: unknown

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:991

setFactory()
setFactory(nodeFactory): void
Parameters

• nodeFactory: NodeFactory

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:651

setNaturalFlow()
setNaturalFlow(outExec): void
Parameters

• outExec: undefined | string

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:621

setState()
setState(state): void
Parameters

• state: Record<string, unknown>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:495

toJSON()
toJSON(): NodeSaveData
Returns

NodeSaveData

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:532

updateElement()
updateElement(type, id?): void
Parameters

• type: "node" | "connection" | "socket" | "control" = 'node'

• id?: string

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1002

waitForEndExecutePromise()
waitForEndExecutePromise(): Promise<void>
Returns

Promise<void>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:670

fromJSON()
static fromJSON(data, __namedParameters): Promise<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>
Parameters

• data: NodeSaveData

• __namedParameters

• __namedParameters.factory?: NodeFactory

Returns

Promise<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:572

Interfaces

InDataParams<N>

Type Parameters

• N

Properties

control?
optional control: InputControlParams<N>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:105

displayName?
optional displayName: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:103

index?
optional index: number;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:109

initial?
optional initial: unknown;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:104

isArray?
optional isArray: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:107

isRequired?
optional isRequired: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:106

name
name: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:102

socketLabel?
optional socketLabel: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:101

type?
optional type: SocketType;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:108

NodeParams

Extended by

Properties

description?
optional description: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:135

factory?
optional factory: NodeFactory;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:140

height?
optional height: number;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:139

id?
optional id: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:137

initialValues?
optional initialValues: Record<string, unknown> | object;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:142

label?
optional label: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:134

name?
optional name: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:136

params?
optional params: Record<string, unknown>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:141

state?
optional state: Record<string, unknown>;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:143

width?
optional width: number;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:138

OutDataParams

Properties

displayLabel?
optional displayLabel: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:94

displayName?
optional displayName: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:95

isArray?
optional isArray: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:96

name
name: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:93

socketLabel?
optional socketLabel: string;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:92

type?
optional type: SocketType;
Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:97

Type Aliases

ConnectionSaveData

type ConnectionSaveData: object;

Type declaration

id
id: string;
source
source: string;
sourceOutput
sourceOutput: string;
target
target: string;
targetInput
targetInput: string;

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:1012

NodeConstructor()<N>

type NodeConstructor<N>: (params?) => N;

Type Parameters

• N = Node

Parameters

• params?: NodeParams

Returns

N

Type declaration

description?
optional description: string;

Description of the node.

id?
optional id: string;
path?
optional path: string[];

Menu path of the node.

tags?
optional tags: string[];

Search tags of the node.

visible?
optional visible: boolean;

Visibility of node

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:157

NodeSaveData

type NodeSaveData: object;

Type declaration

id
id: string;
inputControlValues
inputControlValues: Node["initialValues"];
params
params: Record<string, unknown>;
position?
optional position: object;
position.x
x: number;
position.y
y: number;
selectedInputs
selectedInputs: string[];
selectedOutputs
selectedOutputs: string[];
state
state: Record<string, unknown>;
type
type: string;

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:146

SocketsValues<Sockets>

type SocketsValues<Sockets>: { [K in keyof Sockets]: SocketValueWithDatastructure<SocketValueType<Sockets[K]["type"]>, Sockets[K]["datastructure"]> };

Type Parameters

• Sockets extends { [key in string]: Socket }

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:199

Variables

converters

const converters: Map<SocketType, Map<SocketType, NodeConstructor<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>>>;

Registered converter nodes, from source to target.

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:74

nodeRegistry

const nodeRegistry: SvelteMap<string, NodeConstructor<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>>;

A map of node classes indexed by their id.

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:45

Functions

description()

function description<N>(description): (target) => void

Decorator that adds a description to a node.

Type Parameters

• N

Parameters

• description: string

Returns

Function

Parameters

• target: NodeConstructor<N>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:191

hidden()

function hidden(nodeClass): void

Parameters

• nodeClass: NodeConstructor<Node<Record<string, Socket<SocketType, "scalar" | "array">>, object, object, Record<string, unknown>, Record<string, unknown>>>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:87

path()

function path<N>(...path): (target) => void

Decorator that adds a path to a node.

Type Parameters

• N

Parameters

• …path: string[]

Returns

Function

Parameters

• target: NodeConstructor<N>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:173

registerConverter()

function registerConverter<S, T>(source, target): (nodeClass) => void

Registers a converter node.

Type Parameters

• S extends DataType

• T extends DataType

Parameters

• source: S

• target: T

Returns

Function

Parameters

• nodeClass: typeof ConverterNode

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:79

registerNode()

function registerNode<Inputs, Outputs, Controls, T>(id, type?): (target) => void

Registers a node class.

Type Parameters

• Inputs extends object

• Outputs extends object

• Controls extends object

• T extends "abstract" | "real" = "real"

Parameters

• id: string

• type?: T

Returns

Function

Parameters

• target: T extends "abstract" ? unknown : NodeConstructor<Node<Inputs, Outputs, Controls, Record<string, unknown>, Record<string, unknown>>>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:50

tags()

function tags<N>(...tags): (target) => void

Decorator that adds tags to a node

Type Parameters

• N

Parameters

• …tags: string[]

Returns

Function

Parameters

• target: NodeConstructor<N>

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/nodes/Node.svelte.ts:182