211_getstraightpath__

getStraightPath()

Source on GitHub

Calculates the straight line path between two points.

import { getStraightPath } from '@xyflow/react';
 
const source = { x: 0, y: 20 };
const target = { x: 150, y: 100 };
 
const [path, labelX, labelY, offsetX, offsetY] = getStraightPath({
  sourceX: source.x,
  sourceY: source.y,
  targetX: target.x,
  targetY: target.y,
});
 
console.log(path); //=> "M 0,20L 150,100"
console.log(labelX, labelY); //=> 75, 60
console.log(offsetX, offsetY); //=> 75, 40

Signature

Calculates the straight line path between two points.

Parameters

• [0].sourceX: number The x position of the source handle.
• [0].sourceY: number The y position of the source handle.
• [0].targetX: number The x position of the target handle.
• [0].targetY: number The y position of the target handle.

Returns

[path: string, labelX: number, labelY: number, offsetX: number, offsetY: number]

Notes

• This function returns a tuple (aka a fixed-size array) to make it easier to work with multiple edge paths at once.