logologo
FlowGram.AI
Guide
Examples
Common APIs
API Documentation
English
简体中文
Guide
Examples
Common APIs
API Documentation
English
简体中文
logologo
FlowGram.AI
API Overview

Core

FlowDocument
FlowNodeEntity/WorkflowNodeEntity
WorkflowDocument (free)
WorkflowLinesManager (free)
WorkflowLineEntity (free)
Playground

Hooks

useClientContext
useNodeRender
usePlaygroundTools
useRefresh
useService

Components

EditorRenderer
FixedLayoutEditorProvider
FixedLayoutEditor
FreeLayoutEditorProvider
FreeLayoutEditor
WorkflowNodeRenderer(free)

Services

ClipboardService
CommandService
FlowOperationService
history-service
SelectionService

Utils

DisposableCollection
Disposable
Emitter
getNodeForm

Overview

Core

FlowDocument

  • root
  • getAllNodes
  • getNode
  • getNodeRegistry
  • fromJSON/toJSON
  • registerFlowNodes
  • addNode
  • addFromNode
  • addBlock
  • removeNode
  • onNodeCreate/onNodeUpdate/onNodeDispose
  • traverse
  • toString

FlowNodeEntity/WorkflowNodeEntity

  • Properties
  • Accessors
  • Methods

WorkflowDocument (free)

  • linesManager
  • createWorkflowNodeByType
  • onContentChange

WorkflowLinesManager (free)

  • getAllLines
  • toJSON
  • Custom Arrow Renderer

WorkflowLineEntity (free)

    Playground

    • config

    Hooks

    useClientContext

    • Fixed Layout
    • Free Layout

    useNodeRender

    • Fixed Layout
    • Free Layout

    usePlaygroundTools

    • Fixed Layout
    • Free Layout

    useRefresh

    • Source Code
    • Usage

    useService

    • Custom Service

    Components

    EditorRenderer

      FixedLayoutEditorProvider

        FixedLayoutEditor

          FreeLayoutEditorProvider

            FreeLayoutEditor

              WorkflowNodeRenderer(free)

              • Usage

              Services

              ClipboardService

                CommandService

                  FlowOperationService

                  • Interface

                  history-service

                  • HistoryService
                  • Redo/Undo
                  • Render History

                  SelectionService

                  • Usage

                  Utils

                  DisposableCollection

                  • Usage
                  • Source Code

                  Disposable

                  • Interface
                  • Source Code

                  Emitter

                  • Usage
                  • Source Code

                  getNodeForm

                  • Usage
                  • Return Inteface