类型

¥Types

BackgroundVariant

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

Connection

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

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

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

HandleConnection

HandleConnection 类型是包含 edgeId 的连接。

InternalNode

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

MarkerType

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

MiniMapNodeProps

Node

Node 类型代表 React Flow 需要了解的有关给定节点的所有内容。许多这些属性都可以由 React Flow 或你自己操作，但有些属性（例如宽度和高度）应被视为只读。

NodeChange

onNodesChange 回调采用 NodeChange 对象数组，你应使用该数组来更新流的状态。NodeChange 类型是六种不同对象类型的联合，它们表示节点在流中可以改变的各种方式。

NodeConnection

NodeConnection 类型是包含 edgeId 的连接。

NodeHandle

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

NodeOrigin

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

NodeProps

实现自定义节点时，它被封装在一个启用选择和拖动等基本功能的组件中。你的自定义节点接收以下属性：

OnEdgesChange

OnNodesChange

PanOnScrollMode

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

PanelPosition

此类型主要用于帮助将事物定位在流视口的顶部。例如，MiniMap 和 Controls 组件都采用这种类型的位置属性。

Position

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

ProOptions

默认情况下，我们会在流程的角落渲染一个小的归因，链接回项目。任何人都可以自由删除此归因，无论他们是否是 Pro 订阅者，但我们要求你在这样做之前快速查看我们的删除归因指南。

ReactFlowInstance

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

ReactFlowJsonObject

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

ResizeParams

ResizeParams 类型用于键入 NodeResizer 组件发出的各种事件。有时你还会看到此类型扩展了附加方向字段。

Viewport

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

XYPosition

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