getSimpleBezierPath()
The getSimpleBezierPath
util returns everything you need to render a simple
bezier edge between two nodes.
import { Position, getSimpleBezierPath } from '@xyflow/react';
const source = { x: 0, y: 20 };
const target = { x: 150, y: 100 };
const [path, labelX, labelY, offsetX, offsetY] = getSimpleBezierPath({
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, 40
Signature
Parameters:Name | Type | Default |
---|---|---|
[0].sourceX | number | |
[0].sourceY | number | |
[0].sourcePosition | Position | Position.Bottom |
[0].targetX | number | |
[0].targetY | number | |
[0].targetPosition | Position | Position.Top |
[path: string, labelX: number, labelY: number, offsetX: number, offsetY: number]
path
: the path to use in an SVG<path>
element.labelX
: thex
position you can use to render a label for this edge.labelY
: they
position you can use to render a label for this edge.offsetX
: the absolute difference between the sourcex
position and thex
position of the middle of this path.offsetY
: the absolute difference between the sourcey
position and they
position 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