类型

BackgroundVariant

这三种变体以枚举形式导出，以方便使用。您可以导入枚举并像 BackgroundVariant.Lines 一样使用它，或者直接使用原始字符串值。

Connection

Connection 类型是两个节点之间 Edge 的基本最小描述。addEdge 实用程序可用于将 Connection 升级为 Edge。

ConnectionLineComponentProps

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

ConnectionLineType

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

ConnectionState

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

CoordinateExtent

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

DefaultEdgeOptions

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

DeleteElements

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

Edge

Connection 是两个节点之间边的最小描述，而 Edge 是完整的描述，其中包含 React Flow 需要了解的所有内容才能呈现它。

EdgeChange

onEdgesChange 回调函数接受一个 EdgeChange 对象数组，您应该使用这些对象来更新流的状态。EdgeChange 类型是四种不同对象类型的联合，这些对象表示边在流中可能发生变化的不同方式。

EdgeMarker

边可以选择在边的开始和结束处具有标记。EdgeMarker 类型用于配置这些标记！查看 MarkerType 文档以详细了解可用的边标记类型。

EdgeProps

当您实现自定义边时，它将被包装在一个组件中，该组件启用一些基本功能。您的自定义边组件接收以下道具

FitViewOptions

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

Handle

Handle 属性，如 id、position 和 type。

HandleConnection

HandleConnection 类型是包含 edgeId 的 Connection。

InternalNode

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

MarkerType

边可以选择在任一端具有标记。MarkerType 类型枚举了在配置给定标记时可用的选项。

MiniMapNodeProps

Node

Node 类型代表 React Flow 需要了解的有关给定节点的所有信息。许多这些属性既可以由 React Flow 也可以由您来操作，但某些属性（如宽度和高度）应视为只读。

NodeChange

onNodesChange 回调函数接受一个 NodeChange 对象数组，您应该使用这些对象来更新流的状态。NodeChange 类型是六种不同对象类型的联合，这些对象表示节点在流中可能发生变化的不同方式。

NodeHandle

边可以选择在任一端具有标记。MarkerType 类型枚举了在配置给定标记时可用的选项。

NodeOrigin

节点的来源决定了它相对于自身坐标的放置方式。

NodeProps

当您实现自定义节点时，它将被包装在一个组件中，该组件启用基本功能，如选择和拖动。您的自定义节点接收以下道具

OnEdgesChange

OnNodesChange

PanOnScrollMode

此枚举用于设置用户滚动时平移视口的不同模式。

PanelPosition

此类型主要用于帮助将组件放置在流视口之上。例如，MiniMap 和 Controls 组件都接受此类型的 position 属性。

Position

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

ProOptions

默认情况下，我们在流的角落渲染一个小型的署名，它链接到该项目。无论他们是 Pro 订阅者还是非订阅者，任何人都可以删除此署名，但我们要求您在删除此署名前快速查看我们的删除署名指南。

ReactFlowInstance

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

ReactFlowJsonObject

流的 JSON 兼容表示形式。您可以使用它将流保存到数据库（例如）并在以后加载它。

ResizeParams

ResizeParams 类型用于为 NodeResizer 组件发出的各种事件进行类型化。有时您会看到此类型扩展了额外的 direction 字段。

Viewport

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

XYPosition

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