dag-designer / Exports / IDagDesignerContextValue

Interface: IDagDesignerContextValue

Hierarchy

• IDagDesignerStateValue

• IDagDesignerActionsValue

  ↳ IDagDesignerContextValue

Table of contents

Properties

• definition
• manifests
• objectInfo
• assetUploadBaseUrl
• onRunResult
• onRun
• initialInput
• selectedNodeId
• selectedEdgeId
• connectError
• bindingCleanupMessage
• runResult
• nodeStateMap
• isRunnable
• runProgress
• bindingErrors
• onDefinitionChange
• setSelectedNodeId
• setSelectedEdgeId
• setConnectError
• setRunResult
• resetRunProgress
• setActiveDagRunId
• applyRunProgressEvent
• addNodeFromManifest
• addNodeFromObjectInfo
• updateNode
• updateEdge
• removeNodeById
• removeEdgeById
• setNodeUploading
• setNodeUploadDone

Properties

definition

• definition: IDagDefinition

Inherited from

IDagDesignerStateValue.definition

Defined in

dag-designer/src/components/dag-designer-context.tsx:90

---

manifests

• manifests: INodeManifest[]

Inherited from

IDagDesignerStateValue.manifests

Defined in

dag-designer/src/components/dag-designer-context.tsx:91

---

objectInfo

• objectInfo: TObjectInfo

Inherited from

IDagDesignerStateValue.objectInfo

Defined in

dag-designer/src/components/dag-designer-context.tsx:92

---

assetUploadBaseUrl

• Optional assetUploadBaseUrl: string

Inherited from

IDagDesignerStateValue.assetUploadBaseUrl

Defined in

dag-designer/src/components/dag-designer-context.tsx:93

---

onRunResult

• Optional onRunResult: (result: TResult<IRunResult, IDagError>) => void

Type declaration

▸ (result): void

Parameters

Name	Type
result	TResult<IRunResult, IDagError>

Returns

void

Inherited from

IDagDesignerStateValue.onRunResult

Defined in

dag-designer/src/components/dag-designer-context.tsx:94

---

onRun

• Optional onRun: (input: { definition: IDagDefinition ; input: TPortPayload }, hooks?: IRunProgressHooks) => Promise<TResult<IRunResult, IDagError>>

Type declaration

▸ (input, hooks?): Promise<TResult<IRunResult, IDagError>>

Parameters

Name	Type
input	Object
input.definition	IDagDefinition
input.input	TPortPayload
hooks?	IRunProgressHooks

Returns

Promise<TResult<IRunResult, IDagError>>

Inherited from

IDagDesignerStateValue.onRun

Defined in

dag-designer/src/components/dag-designer-context.tsx:95

---

initialInput

• Optional initialInput: TPortPayload

Inherited from

IDagDesignerStateValue.initialInput

Defined in

dag-designer/src/components/dag-designer-context.tsx:99

---

selectedNodeId

• Optional selectedNodeId: string

Inherited from

IDagDesignerStateValue.selectedNodeId

Defined in

dag-designer/src/components/dag-designer-context.tsx:100

---

selectedEdgeId

• Optional selectedEdgeId: string

Inherited from

IDagDesignerStateValue.selectedEdgeId

Defined in

dag-designer/src/components/dag-designer-context.tsx:101

---

connectError

• Optional connectError: string

Inherited from

IDagDesignerStateValue.connectError

Defined in

dag-designer/src/components/dag-designer-context.tsx:102

---

bindingCleanupMessage

• Optional bindingCleanupMessage: string

Inherited from

IDagDesignerStateValue.bindingCleanupMessage

Defined in

dag-designer/src/components/dag-designer-context.tsx:103

---

runResult

• Optional runResult: IRunResult

Inherited from

IDagDesignerStateValue.runResult

Defined in

dag-designer/src/components/dag-designer-context.tsx:104

---

nodeStateMap

• nodeStateMap: Record<string, INodeState>

Inherited from

IDagDesignerStateValue.nodeStateMap

Defined in

dag-designer/src/components/dag-designer-context.tsx:105

---

isRunnable

• isRunnable: boolean

Inherited from

IDagDesignerStateValue.isRunnable

Defined in

dag-designer/src/components/dag-designer-context.tsx:106

---

runProgress

• runProgress: IRunProgressState

Inherited from

IDagDesignerStateValue.runProgress

Defined in

dag-designer/src/components/dag-designer-context.tsx:107

---

bindingErrors

• bindingErrors: string[]

Inherited from

IDagDesignerStateValue.bindingErrors

Defined in

dag-designer/src/components/dag-designer-context.tsx:108

---

onDefinitionChange

• onDefinitionChange: (definition: IDagDefinition) => void

Type declaration

▸ (definition): void

Parameters

Name	Type
definition	IDagDefinition

Returns

void

Inherited from

IDagDesignerActionsValue.onDefinitionChange

Defined in

dag-designer/src/components/dag-designer-context.tsx:112

---

setSelectedNodeId

• setSelectedNodeId: (nodeId: undefined | string) => void

Type declaration

▸ (nodeId): void

Parameters

Name	Type
nodeId	undefined | string

Returns

void

Inherited from

IDagDesignerActionsValue.setSelectedNodeId

Defined in

dag-designer/src/components/dag-designer-context.tsx:113

---

setSelectedEdgeId

• setSelectedEdgeId: (edgeId: undefined | string) => void

Type declaration

▸ (edgeId): void

Parameters

Name	Type
edgeId	undefined | string

Returns

void

Inherited from

IDagDesignerActionsValue.setSelectedEdgeId

Defined in

dag-designer/src/components/dag-designer-context.tsx:114

---

setConnectError

• setConnectError: (error: undefined | string) => void

Type declaration

▸ (error): void

Parameters

Name	Type
error	undefined | string

Returns

void

Inherited from

IDagDesignerActionsValue.setConnectError

Defined in

dag-designer/src/components/dag-designer-context.tsx:115

---

setRunResult

• setRunResult: (result: undefined | IRunResult) => void

Type declaration

▸ (result): void

Parameters

Name	Type
result	undefined | IRunResult

Returns

void

Inherited from

IDagDesignerActionsValue.setRunResult

Defined in

dag-designer/src/components/dag-designer-context.tsx:116

---

resetRunProgress

• resetRunProgress: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

IDagDesignerActionsValue.resetRunProgress

Defined in

dag-designer/src/components/dag-designer-context.tsx:117

---

setActiveDagRunId

• setActiveDagRunId: (dagRunId: string) => void

Type declaration

▸ (dagRunId): void

Parameters

Name	Type
dagRunId	string

Returns

void

Inherited from

IDagDesignerActionsValue.setActiveDagRunId

Defined in

dag-designer/src/components/dag-designer-context.tsx:118

---

applyRunProgressEvent

• applyRunProgressEvent: (event: TRunProgressEvent) => void

Type declaration

▸ (event): void

Parameters

Name	Type
event	TRunProgressEvent

Returns

void

Inherited from

IDagDesignerActionsValue.applyRunProgressEvent

Defined in

dag-designer/src/components/dag-designer-context.tsx:119

---

addNodeFromManifest

• addNodeFromManifest: (manifest: INodeManifest) => void

Type declaration

▸ (manifest): void

Parameters

Name	Type
manifest	INodeManifest

Returns

void

Inherited from

IDagDesignerActionsValue.addNodeFromManifest

Defined in

dag-designer/src/components/dag-designer-context.tsx:120

---

addNodeFromObjectInfo

• addNodeFromObjectInfo: (nodeType: string, info: INodeObjectInfo) => void

Type declaration

▸ (nodeType, info): void

Parameters

Name	Type
nodeType	string
info	INodeObjectInfo

Returns

void

Inherited from

IDagDesignerActionsValue.addNodeFromObjectInfo

Defined in

dag-designer/src/components/dag-designer-context.tsx:121

---

updateNode

• updateNode: (nextNode: IDagNode) => void

Type declaration

▸ (nextNode): void

Parameters

Name	Type
nextNode	IDagNode

Returns

void

Inherited from

IDagDesignerActionsValue.updateNode

Defined in

dag-designer/src/components/dag-designer-context.tsx:122

---

updateEdge

• updateEdge: (nextEdge: IDagEdgeDefinition) => void

Type declaration

▸ (nextEdge): void

Parameters

Name	Type
nextEdge	IDagEdgeDefinition

Returns

void

Inherited from

IDagDesignerActionsValue.updateEdge

Defined in

dag-designer/src/components/dag-designer-context.tsx:123

---

removeNodeById

• removeNodeById: (nodeId: string) => void

Type declaration

▸ (nodeId): void

Parameters

Name	Type
nodeId	string

Returns

void

Inherited from

IDagDesignerActionsValue.removeNodeById

Defined in

dag-designer/src/components/dag-designer-context.tsx:124

---

removeEdgeById

• removeEdgeById: (edgeId: string) => void

Type declaration

▸ (edgeId): void

Parameters

Name	Type
edgeId	string

Returns

void

Inherited from

IDagDesignerActionsValue.removeEdgeById

Defined in

dag-designer/src/components/dag-designer-context.tsx:125

---

setNodeUploading

• setNodeUploading: (nodeId: string, description: string) => void

Type declaration

▸ (nodeId, description): void

Parameters

Name	Type
nodeId	string
description	string

Returns

void

Inherited from

IDagDesignerActionsValue.setNodeUploading

Defined in

dag-designer/src/components/dag-designer-context.tsx:126

---

setNodeUploadDone

• setNodeUploadDone: (nodeId: string) => void

Type declaration

▸ (nodeId): void

Parameters

Name	Type
nodeId	string

Returns

void

Inherited from

IDagDesignerActionsValue.setNodeUploadDone

Defined in

dag-designer/src/components/dag-designer-context.tsx:127