getBezierPath()
The getBezierPath util returns everything you need to render a bezier edge between two nodes.
import { Position, getBezierPath } from '@xyflow/react'; const source = { x: 0, y: 20 }; const target = { x: 150, y: 100 }; const [path, labelX, labelY, offsetX, offsetY] = getBezierPath({ sourceX: source.x, sourceY: source.y, sourcePosition: Position.Right, targetX: target.x, targetY: target.y, targetPosition: Position.Left, }); console.log(path); //=> "M0,20 C75,20 75,100 150,100" console.log(labelX, labelY); //=> 75, 60 console.log(offsetX, offsetY); //=> 75, 40Signature
Parameters:| Name | Type | Default |
|---|---|---|
[0].sourceX | numberThe | |
[0].sourceY | numberThe | |
[0].sourcePosition | PositionThe position of the source handle. | Position.Bottom |
[0].targetX | numberThe | |
[0].targetY | numberThe | |
[0].targetPosition | PositionThe position of the target handle. | Position.Top |
[0].curvature | numberThe curvature of the bezier edge. | 0.25 |
[path: string, labelX: number, labelY: number, offsetX: number, offsetY: number]A path string you can use in an SVG, the labelX and labelY position (center of path) and offsetX, offsetY between source handle and label.
path: the path to use in an SVG<path>element.labelX: thexposition you can use to render a label for this edge.labelY: theyposition you can use to render a label for this edge.offsetX: the absolute difference between the sourcexposition and thexposition of the middle of this path.offsetY: the absolute difference between the sourceyposition and theyposition of the middle of this path.
Notes
- This function returns a tuple (aka a fixed-size array) to make it easier to work with multiple edge paths at once.
Last updated on