ConnectionSetup

Classes

ConnectionPlugin

Extends

• ConnectionPlugin<Schemes, AreaExtra>

Constructors

new ConnectionPlugin()

new ConnectionPlugin(factory, area): ConnectionPlugin

Parameters

• factory: NodeFactory

• area: AreaPlugin<Schemes, AreaExtra>

Returns

ConnectionPlugin

Overrides

BaseConnectionPlugin<Schemes, AreaExtra>.constructor

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:31

Properties

__scope

__scope: object;

parents

parents: [AreaExtra | Requires];

produces

produces: Connection;

Inherited from

BaseConnectionPlugin.__scope

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:49

lastClickedSocket

lastClickedSocket: boolean = false;

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:27

lastConn?

optional lastConn: 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>>>;

Last picked connection.

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:30

lastPickedSockedData

lastPickedSockedData: undefined | SocketData & object;

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:28

name

name: string;

Inherited from

BaseConnectionPlugin.name

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:46

parent?

optional parent: any;

Inherited from

BaseConnectionPlugin.parent

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:48

picked

picked: boolean = false;

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:26

presets

presets: Preset<Schemes>[];

Inherited from

BaseConnectionPlugin.presets

Defined in

tmp/graph-editor/node_modules/rete-connection-plugin/_types/index.d.ts:42

signal

signal: Signal<any>;

Inherited from

BaseConnectionPlugin.signal

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:47

Methods

addPipe()

addPipe(middleware): void

Parameters

• middleware: Pipe<AreaExtra | Connection | Requires>

Returns

void

Inherited from

BaseConnectionPlugin.addPipe

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:54

addPreset()

addPreset(preset): void

Add preset to the plugin

Parameters

• preset: Preset<Schemes>

Preset to add

Returns

void

Inherited from

BaseConnectionPlugin.addPreset

Defined in

tmp/graph-editor/node_modules/rete-connection-plugin/_types/index.d.ts:53

drop()

drop(): void

Drop pseudo-connection if exists

Returns

void

Emits

connectiondrop

Inherited from

BaseConnectionPlugin.drop

Defined in

tmp/graph-editor/node_modules/rete-connection-plugin/_types/index.d.ts:60

emit()

emit<C>(context): Promise<undefined | Extract<object, C> | Extract<object, C>>

Type Parameters

• C extends Connection

Parameters

• context: C

Returns

Promise<undefined | Extract<object, C> | Extract<object, C>>

Inherited from

BaseConnectionPlugin.emit

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:59

hasParent()

hasParent(): boolean

Returns

boolean

Inherited from

BaseConnectionPlugin.hasParent

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:60

parentScope()

parentScope()

parentScope<T, P>(): Scope<T, P>

Type Parameters

• T extends AreaExtra | Requires

• P extends []

Returns

Scope<T, P>

Inherited from

BaseConnectionPlugin.parentScope

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:61

parentScope(type)

parentScope<T>(type): T

Type Parameters

• T

Parameters

• type: Type<T>

Returns

T

Inherited from

BaseConnectionPlugin.parentScope

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:62

pick()

pick(event, type): Promise<void>

Handles pointer down and up events to control interactive connection creation.

Parameters

• event: PointerEvent

• type: EventType

Returns

Promise<void>

Overrides

BaseConnectionPlugin.pick

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:91

setParent()

setParent(scope): void

Parameters

• scope: Scope< | AreaExtra | object | object | RenderSignal<"socket", object> | object, []>

Returns

void

Overrides

BaseConnectionPlugin.setParent

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:37

update()

update(): void

Returns

void

Inherited from

BaseConnectionPlugin.update

Defined in

tmp/graph-editor/node_modules/rete-connection-plugin/_types/index.d.ts:55

use()

use<S>(scope): object

Type Parameters

• S extends Scope<any, any[]>

Parameters

• scope: NestedScope<S, [Connection, AreaExtra | Requires]>

Returns

object

debug()

Type Parameters

• T extends []

Parameters

• _f

Returns

void

Inherited from

BaseConnectionPlugin.use

Defined in

tmp/graph-editor/node_modules/rete/_types/scope.d.ts:55

---

ConnectionSetup

Extends

• SetupClass

Constructors

new ConnectionSetup()

new ConnectionSetup(): ConnectionSetup

Returns

ConnectionSetup

Inherited from

SetupClass.constructor

Methods

setup()

setup(
   editor,
   area,
   factory): void

Parameters

• editor: NodeEditor

• area: AreaPlugin<Schemes, AreaExtra>

• factory: NodeFactory

Returns

void

Overrides

SetupClass.setup

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:164

Functions

setupConnections()

function setupConnections(params): void | Promise<void> | SetupParams | Promise<SetupParams>

Parameters

• params: SetupParams

Returns

void | Promise<void> | SetupParams | Promise<SetupParams>

Defined in

tmp/graph-editor/src/lib/graph-editor/setup/ConnectionSetup.ts:169