Skip to content

IWaldiezFlowStore

@waldiez/react v0.5.3


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

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: () => undefined | ReactFlowInstance

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

Get the ReactFlowInstance of the flow.

ReturnsΒΆ

undefined | ReactFlowInstance

The ReactFlowInstance of the flow if available, otherwise undefined.


getViewport()ΒΆ

getViewport: () => undefined | Viewport

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

Get the Viewport of the flow.

ReturnsΒΆ

undefined | Viewport

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ΒΆ

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ΒΆ

null | number

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