类型

Align

Align 类型包含 NodeToolbar 组件 align 属性所需的值。

AriaLabelConfig

使用 AriaLabelConfig，你可以自定义 React Flow 使用的 aria 标签和描述。

BackgroundVariant

这三种变体作为一个枚举导出以方便使用。你可以导入这个枚举并像使用 BackgroundVariant.Lines 那样使用它，也可以直接使用原始字符串值。

ColorMode

ColorMode 类型定义了 ReactFlow 组件可用的颜色模式。

Connection

连接类型是两个节点之间边的基本最小描述。addEdge 工具可以用来将连接升级为边。

ConnectionLineComponent

自定义 React 组件，用于在创建边时渲染连接线。

ConnectionLineComponentProps

如果你想为连接线渲染自定义组件，可以在 ReactFlow 组件上设置 connectionLineComponent 属性。ConnectionLineComponentProps 会传递给你的自定义组件。

ConnectionLineType

如果你在 ReactFlow 组件上设置 connectionLineType 属性，它将决定在创建新边时渲染的连接线样式。

ConnectionMode

指定节点之间建立连接的规则。

ConnectionState

有关正在进行的连接的数据。

CoordinateExtent

坐标范围表示坐标系统中的两个点：一个在左上角，一个在右下角。它用于表示流程中节点的边界或视口的边界。

DefaultEdgeOptions

Edge 上的许多属性是可选的。当创建一个新的 edge 时，未提供的属性将使用传递给 ReactFlow 组件的 defaultEdgeOptions 属性的默认值进行填充。

DeleteElements

DeleteElements 从流中删除节点和边缘，并异步返回已删除的边缘和节点。

Edge

当连接是两个节点之间边的最小描述时，`Edge` 是完整的描述，包含 React Flow 渲染它所需知道的所有信息。

EdgeChange

onEdgesChange 回调接收一个 EdgeChange 对象数组，你应该 use to update your flow's state. The EdgeChange type is a union of four different object types that represent that various ways an edge can change in a flow.

EdgeMarker

边可以在边的起点和终点选择性地有标记。EdgeMarker 类型 is used to configure those markers! Check the docs for MarkerType for details on what types of edge marker are available.

EdgeMouseHandler

EdgeMouseHandler 类型定义了鼠标事件发生在边上时调用的回调函数。

EdgeProps

当你实现自定义边时，它会被封装在一个启用某些基本功能的组件中。你的自定义边组件接收以下属性:

EdgeTypes

EdgeTypes 类型用于定义自定义边类型。

FitViewOptions

在调用 fitView 时，可以使用这些选项来自定义行为。例如，duration 选项可以用来在给定时间内平滑地转换视口。

Handle

处理 id、位置和类型等属性。

HandleConnection

HandleConnection 类型是包含 edgeId 的连接。

InternalNode

InternalNode 是基础 Node 类型的扩展，带有 React Flow 内部用于渲染的附加属性。

IsValidConnection

用于确定节点之间连接是否有效的函数类型。

KeyCode

表示键盘按键代码或组合键。

MarkerType

边缘的任一端可选择性地有一个标记。MarkerType 类型列举了 the options available to you when configuring a given marker.

MiniMapNodeProps

MiniMapNodeProps 类型定义了小地图组件中节点的属性。

Node

节点类型表示 React Flow 需要了解的关于给定节点的所有信息。许多这些属性可以由 React Flow 或你进行操作，但有些属性，如宽度和高度，应视为只读。

NodeChange

onNodesChange 回调接受一个 NodeChange 对象数组，你应该 use to update your flow's state. The NodeChange type is a union of six different object types that represent that various ways an node can change in a flow.

NodeConnection

NodeConnection 类型是包含 edgeId 的连接。

NodeHandle

NodeHandle 类型用于在使用服务器端渲染时定义节点的句柄。

NodeMouseHandler

NodeMouseHandler 类型定义了在鼠标事件发生时调用的回调函数 occur on a node.

NodeOrigin

Node 的原点决定了它相对于自身坐标的放置方式。

NodeProps

当你实现一个自定义节点时，它会被封装在一个组件中，该组件提供基本功能，如选择和拖拽。你的自定义节点会接收以下属性：

NodeTypes

NodeTypes 类型用于定义自定义节点类型。

OnBeforeDelete

OnBeforeDelete 类型定义了在删除节点或边之前调用的回调函数。

OnConnect

节点之间创建新连接时触发回调函数。

OnConnectEnd

完成或取消节点之间的连接尝试时触发回调函数。

OnConnectStart

开始创建节点间连接时触发回调函数。

OnDelete

OnDelete 类型定义了删除节点或边时调用的回调函数。

OnEdgesChange

OnEdgesDelete

OnEdgesDelete 类型定义了删除边时调用的回调函数。

OnError

OnError 类型定义了发生错误时调用的回调函数。

OnInit

OnInit 类型定义了在初始化 ReactFlow 实例时调用的回调函数。

OnMove

在视口移动（例如平移或缩放）时调用。

OnNodeDrag

OnNodeDrag 类型定义了在拖动节点时调用的回调函数。

OnNodesChange

OnNodesDelete

OnNodesDelete 类型定义了在删除节点时调用的回调函数。

OnReconnect

现有边重新连接到其他节点或句柄时触发回调函数。

OnSelectionChangeFunc

流程图中节点或边的选择发生变化时调用。

PanOnScrollMode

配置视口如何响应滚动事件，允许自由、垂直或 horizontal panning.

PanelPosition

这种类型主要用于帮助在流视口上定位元素。例如，MiniMap 和 Controls 组件都使用这种类型的 position 属性。

Position

虽然 PanelPosition 可以用来将组件放置在容器的角落，但 Position 枚举的精确度较低，主要用于与边缘和控制柄相关的位置。

ProOptions

默认情况下，我们会在你的流程角落显示一个小的署名，并链接回该项目。

ReactFlowInstance

ReactFlowInstance 提供了一组方法来查询和操作流的内部状态。你可以通过使用 useReactFlow 钩子或者将监听器附加到 onInit 事件来获取一个实例。

ReactFlowJsonObject

你流程的 JSON 兼容表示。你可以使用它将流程保存到数据库中，例如，然后稍后再加载回来。

Rect

Rect 类型定义了一个具有尺寸和位置的矩形。

ResizeParams

ResizeParams 类型用于为由...发出的各种事件定义类型 NodeResizer component. You'll sometimes see this type extended with an additional direction field too.

SelectionDragHandler

在交互操作期间处理选定节点的拖动事件。

SelectionMode

控制流程图中节点的选择方式，提供完全或部分选择行为。

SnapGrid

SnapGrid 类型定义了在窗格上捕捉节点的网格大小。

Viewport

在内部，React Flow 维护了一个独立于页面其他部分的坐标系统。Viewport 类型告诉你在该系统中你的流程当前显示的位置以及缩放程度。

XYPosition

所有位置都存储在具有 x 和 y 坐标的对象中。

ZIndexMode

ZIndexMode 类型用于定义如何计算节点和边的 z-index。