參考類型

類型

BackgroundVariant

為了方便起見,這三個變體會以列舉方式匯出。您可以匯入列舉並像 BackgroundVariant.Lines 這樣使用它,或者您可以直接使用原始字串值。

閱讀更多

Connection

Connection 類型是兩個節點之間邊的最小基本描述。addEdge 工具可用於將 Connection 升級為 Edge。

閱讀更多

ConnectionLineComponentProps

如果您想要為連接線渲染自訂元件,您可以在 ReactFlow 元件上設定 connectionLineComponent 屬性。ConnectionLineComponentProps 會傳遞到您的自訂元件。

閱讀更多

ConnectionLineType

如果您在 ReactFlow 元件上設定 connectionLineType 屬性,它將決定建立新邊時所渲染的連接線樣式。

閱讀更多

CoordinateExtent

座標範圍代表座標系統中的兩個點:一個在左上角,一個在右下角。它用於表示流程中節點的範圍或視口的範圍。

閱讀更多

DefaultEdgeOptions

邊上的許多屬性都是可選的。當建立新邊時,未提供的屬性將會填入傳遞至 ReactFlow 元件 defaultEdgeOptions 屬性的預設值。

閱讀更多

Edge

Connection 是兩個節點之間邊的最小描述,而 Edge 則是完整的描述,包含 React Flow 渲染它所需的一切。

閱讀更多

EdgeChange

onEdgesChange 回呼接受 EdgeChange 物件的陣列,您應該使用這些物件來更新流程的狀態。EdgeChange 類型是四種不同物件類型的聯合,代表邊在流程中可以變更的各種方式。

閱讀更多

EdgeMarker

邊可以選擇性地在邊的開始和結束位置加上標記。EdgeMarker 類型用於設定這些標記!請查看 MarkerType 的文件,以瞭解可用的邊標記類型詳細資訊。

閱讀更多

EdgeProps

當您實作自訂邊時,它會包裝在啟用一些基本功能的元件中。您的自訂邊元件會收到以下屬性

閱讀更多

FitViewOptions

當呼叫 fitView 時,可以使用這些選項來自訂行為。例如,可以使用 duration 選項在給定的時間內平穩地轉換視口。

閱讀更多

InternalNode

InternalNode 是基本 Node 類型的延伸,具有 React Flow 內部用於渲染的其他屬性。

閱讀更多

MarkerType

邊可以選擇性地在任一端加上標記。MarkerType 類型會列舉設定指定標記時可用的選項。

閱讀更多

Node

Node 類型代表 React Flow 需要知道的關於指定節點的所有資訊。這些屬性中的許多屬性可以由 React Flow 或您來操作,但某些屬性(例如寬度和高度)應視為唯讀。

閱讀更多

NodeChange

onNodesChange 回呼接受 NodeChange 物件的陣列,您應該使用這些物件來更新流程的狀態。NodeChange 類型是六種不同物件類型的聯合,代表節點在流程中可以變更的各種方式。

閱讀更多

NodeHandle

邊可以選擇性地在任一端加上標記。MarkerType 類型會列舉設定指定標記時可用的選項。

閱讀更多

NodeProps

當您實作自訂節點時,它會包裝在啟用基本功能(例如選取和拖曳)的元件中。您的自訂節點會收到以下屬性

閱讀更多

PanelPosition

此類型主要用於協助在流程視口頂端放置項目。例如,MiniMap 和 Controls 元件都會採用此類型的 position 屬性。

閱讀更多

Position

雖然 PanelPosition 可用於將元件放置在容器的角落,但 Position 列舉的精確度較低,主要用於邊和控制點的相關位置。

閱讀更多

ProOptions

預設情況下,我們會在您的流程角落渲染一個小小的歸因,連結回專案。任何人都可以自由移除此歸因,無論他們是否為 Pro 訂閱者,但我們要求您在移除之前快速瀏覽我們的移除歸因指南。

閱讀更多

ReactFlowInstance

ReactFlowInstance 提供了一組方法來查詢和操作流程的內部狀態。您可以使用 useReactFlow Hook 或將監聽器附加至 onInit 事件來取得執行個體。

閱讀更多

ReactFlowJsonObject

流程的 JSON 相容表示法。例如,您可以使用此表示法將流程儲存到資料庫,並在稍後載入回來。

閱讀更多

ResizeParams

ResizeParams 類型用於鍵入 NodeResizer 元件發出的各種事件。您有時也會看到此類型也使用額外的方向欄位來擴充。

閱讀更多

Viewport

在內部,React Flow 維護一個獨立於頁面其他部分的座標系統。Viewport 類型會告訴您流程目前在該系統中顯示的位置以及放大或縮小的程度。

閱讀更多