PythonDataflowEngine

Classes

PythonDataflowEngine<Schemes>

DataflowEngine is a plugin that integrates Dataflow with NodeEditor making it easy to use. Additionally, it provides a cache for the data of each node in order to avoid recurring calculations.

Priority

10

Listens

nodecreated

Listens

noderemoved

Extends

• Scope<never, [Root<Schemes>]>

Type Parameters

• Schemes extends PythonDataflowEngineScheme

Constructors

new PythonDataflowEngine()

new PythonDataflowEngine<Schemes>(configure?): PythonDataflowEngine<Schemes>

Parameters

• configure?: Configure<Schemes>

Returns

PythonDataflowEngine<Schemes>

Overrides

`Scope< never, [Root]

.constructor`

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:34

Properties

__scope

__scope: object;

parents

parents: [Root<Schemes>];

produces

produces: never;

Inherited from

Scope.__scope

Defined in

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

cache

cache: Cache<string, Cancellable<Record<string, unknown>>>;

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:30

dataflow?

optional dataflow: Dataflow<Schemes>;

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:29

editor

editor: NodeEditor<Schemes>;

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:28

name

name: string;

Inherited from

Scope.name

Defined in

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

parent?

optional parent: any;

Inherited from

Scope.parent

Defined in

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

signal

signal: Signal<any>;

Inherited from

Scope.signal

Defined in

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

Methods

addPipe()

addPipe(middleware): void

Parameters

• middleware: Pipe<Root<Schemes>>

Returns

void

Inherited from

Scope.addPipe

Defined in

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

emit()

emit<C>(context): Promise<undefined>

Type Parameters

• C extends never

Parameters

• context: C

Returns

Promise<undefined>

Inherited from

Scope.emit

Defined in

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

fetch()

fetch(nodeId): Promise<Record<string, any>>

Fetches output data of the node

Parameters

• nodeId: string

Node id to fetch data from

Returns

Promise<Record<string, any>>

Throws

Cancelled when reset is called while fetching data

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:126

fetchInputs()

fetchInputs(nodeId): Promise<Record<string, any>>

Fetches input data for the node by fetching data for all its predecessors recursively.

Parameters

• nodeId: string

Node id to fetch input data for

Returns

Promise<Record<string, any>>

Throws

Cancelled when reset` is called while fetching data

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:117

hasParent()

hasParent(): boolean

Returns

boolean

Inherited from

Scope.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 Root<Schemes>

• P extends []

Returns

Scope<T, P>

Inherited from

Scope.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

Scope.parentScope

Defined in

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

reset()

reset(nodeId?, alreadyResetNodes?): void

Resets the cache of the node and all its predecessors.

Parameters

• nodeId?: string

Node id to reset. If not specified, all nodes will be reset.

• alreadyResetNodes?: Set<string> = ...

Returns

void

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:93

setParent()

setParent(scope): void

Parameters

• scope: Scope<Root<Schemes>, []>

Returns

void

Overrides

Scope.setParent

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:48

use()

use<S>(scope): object

Type Parameters

• S extends Scope<any, any[]>

Parameters

• scope: NestedScope<S, [never, Root<Schemes>]>

Returns

object

debug()

Type Parameters

• T extends []

Parameters

• _f

Returns

void

Inherited from

Scope.use

Defined in

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

Type Aliases

PythonDataflowEngineScheme

type PythonDataflowEngineScheme: GetSchemes<Schemes["Node"], Schemes["Connection"]>;

Defined in

tmp/graph-editor/src/lib/graph-editor/engine/PythonDataflowEngine.ts:9