diff --git a/.gitignore b/.gitignore index 229a652d98a..5255e9fb725 100644 --- a/.gitignore +++ b/.gitignore @@ -91,3 +91,6 @@ scripts/verdaccio.sh # Local Netlify folder .netlify + +# Don't ignore the specific Points.dist() docs folder +!markdown/dev/reference/api/point/dist diff --git a/markdown/dev/reference/api/point/dist/en.md b/markdown/dev/reference/api/point/dist/en.md new file mode 100644 index 00000000000..fa8461f011d --- /dev/null +++ b/markdown/dev/reference/api/point/dist/en.md @@ -0,0 +1,33 @@ +--- +title: Point.dist() +--- + +A point's `dist()` method returns the distance (in mm) between this point and the point you pass it. + +```js +float point.dist(Point point) +``` + + + +```js +let { Point, points, Path, paths } = part.shorthand() + +points.from = new Point(10, 10) +points.to = new Point(80, 70) + +points.text = points.from + .shiftFractionTowards(points.to, 0.6) + .attr('data-text', points.from.dist(points.to) + 'mm') + .attr('data-text-class', 'text-sm fill-note center') + +paths.line = new Path() + .move(points.from) + .line(points.to) + .attr('class', 'dashed') + +return part +```