IWaldiezFlowStore

@waldiez/react v0.6.1

Defined in: src/waldiez/models/Stores/IFlowStore.ts:17

Properties¶

exportFlow()¶

exportFlow: (hideSecrets, skipLinks) => WaldiezFlow

Defined in: src/waldiez/models/Stores/IFlowStore.ts:83

Export the current flow.

Parameters¶

hideSecrets¶

boolean

skipLinks¶

boolean

Returns¶

WaldiezFlow

The exported flow.

See¶

WaldiezFlow

getFlowEdges()¶

getFlowEdges: () => object

Defined in: src/waldiez/models/Stores/IFlowStore.ts:62

Get the flow edges.

Returns¶

object

An object containing used and remaining edges.

remaining¶

remaining: WaldiezEdge[]

used¶

used: WaldiezEdge[]

See¶

WaldiezEdge

getFlowInfo()¶

getFlowInfo: () => WaldiezFlowInfo

Defined in: src/waldiez/models/Stores/IFlowStore.ts:38

Get the flow information.

Returns¶

WaldiezFlowInfo

The flow information.

See¶

WaldiezFlowInfo

getRfInstance()¶

getRfInstance: () => ReactFlowInstance | undefined

Defined in: src/waldiez/models/Stores/IFlowStore.ts:27

Get the ReactFlowInstance of the flow.

Returns¶

ReactFlowInstance | undefined

The ReactFlowInstance of the flow if available, otherwise undefined.

getViewport()¶

getViewport: () => Viewport | undefined

Defined in: src/waldiez/models/Stores/IFlowStore.ts:22

Get the Viewport of the flow.

Returns¶

Viewport | undefined

The Viewport of the flow if available, otherwise undefined.

importFlow()¶

importFlow: (items, flowData, typeShown) => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:75

Import a flow into the store.

Parameters¶

items¶

ThingsToImport

flowData¶

ImportedFlow

typeShown¶

WaldiezNodeType

Returns¶

void

See¶

• ThingsToImport
• ImportedFlow
• WaldiezNodeType

onFlowChanged()¶

onFlowChanged: () => WaldiezFlow

Defined in: src/waldiez/models/Stores/IFlowStore.ts:43

Callback function to handle flow changes.

Returns¶

WaldiezFlow

The current flow.

See¶

WaldiezFlow

onViewportChange()¶

onViewportChange: (viewport, nodeType) => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:50

Callback function to handle viewport changes.

Parameters¶

viewport¶

x¶

number

y¶

number

zoom¶

number

nodeType¶

WaldiezNodeType

Returns¶

void

See¶

WaldiezNodeType

saveFlow()¶

saveFlow: () => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:56

Save the current flow.

Returns¶

void

The saved flow.

See¶

WaldiezFlow

setRfInstance()¶

setRfInstance: (rfInstance) => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:32

Set the ReactFlowInstance of the flow.

Parameters¶

rfInstance¶

ReactFlowInstance

Returns¶

void

updateFlowInfo()¶

updateFlowInfo: (data) => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:107

Update the flow information.

Parameters¶

data¶

cacheSeed¶

number | null

description¶

string

isAsync¶

boolean

name¶

string

requirements¶

string[]

tags¶

string[]

Returns¶

void

updateFlowOrder()¶

updateFlowOrder: (data) => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:90

Update the flow order.

Parameters¶

data¶

object[]

Returns¶

void

updateFlowPrerequisites()¶

updateFlowPrerequisites: (edges) => void

Defined in: src/waldiez/models/Stores/IFlowStore.ts:96

Update the flow prerequisites.

Parameters¶

edges¶

WaldiezEdge[]

Returns¶

void

See¶

WaldiezEdge