Skip to content
DocumentationTypes

Type Reference

Core data types used throughout the project for representing flow schema and flow editor components and configurations.

Class FlowSchema

Represents the complete schema of a flow diagram.

Parameters

  • version (str): Schema version identifier
  • nodes (List[FlowNode]): List of all nodes in the flow
  • connections (List[FlowConnection]): List of all connections between nodes
  • viewport (FlowViewport): Current state of the editor viewport

Class StreamlitFlowResponse

Represents the response structure for Streamlit flow operations.

Parameters

  • command (Union[str, Literal[“default”, “execute”, “save”]]): The command to be executed
  • editor_schema (FlowSchema): The complete flow editor schema

Class FlowNode

Represents a node in the flow editor with its complete configuration.

Parameters

  • id (str): Unique identifier for the node
  • type (str): Type of the node
  • name (str): Display name of the node
  • label (str): Label for identifying the node
  • inputs (List[FlowNodeInterface]): List of input interfaces
  • outputs (List[FlowNodeInterface]): List of output interfaces
  • options (List[FlowNodeOption]): List of node options
  • position (FlowNodePosition): Position of the node in the editor
  • measured (FlowNodeMeasured): Dimensions of the node

Class FlowConnection

Represents a connection between two nodes in the flow editor.

Parameters

  • id (str): Unique identifier for the connection
  • outputNode (str): ID of the node where the connection starts
  • outputNodeInterface (str): Name of the output interface on the source node
  • inputNode (str): ID of the node where the connection ends
  • inputNodeInterface (str): Name of the input interface on the target node

Class FlowNodeInterface

Represents an interface for a flow node.

Parameters

  • name (str): Name of the interface
  • itype (str): Type of the interface

Class FlowNodeOption

Represents an option for a flow node.

Parameters

  • name (str): Name of the option
  • value (NodeOptionValue): Value of the option (can be int, float, str, None, or bool)

Class FlowViewport

Represents the current view state of the flow editor.

Parameters

  • x (float): X-coordinate of the viewport position
  • y (float): Y-coordinate of the viewport position
  • zoom (float): Current zoom level of the viewport

Class FlowNodePosition

Represents the position of a node in the flow editor.

Parameters

  • x (float): X-coordinate position of the node
  • y (float): Y-coordinate position of the node

Class FlowNodeMeasured

Represents the dimensions of a node in the flow editor.

Parameters

  • width (int): Width of the node in pixels
  • height (int): Height of the node in pixels
API Reference