From a28420f6f40cb3a9899fa55ea95a487fcf62458c Mon Sep 17 00:00:00 2001 From: Joost De Cock Date: Thu, 29 Sep 2022 16:19:29 +0200 Subject: [PATCH] chore(markdown): Updated Point.shiftOutwards() docs --- .../reference/api/point/shiftoutwards/en.md | 53 ++++++++++--------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/markdown/dev/reference/api/point/shiftoutwards/en.md b/markdown/dev/reference/api/point/shiftoutwards/en.md index e08d536d835..f10cdfd6a95 100644 --- a/markdown/dev/reference/api/point/shiftoutwards/en.md +++ b/markdown/dev/reference/api/point/shiftoutwards/en.md @@ -2,37 +2,40 @@ title: Point.shiftOutwards() --- -Returns a new `Point` that is shifted `distance` (mm) beyond the `target` in the direction of the target point. +The `Point.shiftOutwards()` method returns a new `Point` that is shifted +`distance` (mm) beyond the `target` in the direction of the target point. -## Point.shiftOutwards() signature +## Signature ```js Point point.shiftOutwards(Point target, float distance) ``` -## Point.shiftOutwards() example +## Example - -An example of the Point.shiftOutwards() method + +```js +({ Point, points, Path, paths, macro, part }) => { + + points.A = new Point(90, 70).setText("Point A", "text-sm right") + points.B = new Point(10, 10).setText("Point B", "text-sm") + points.C = points.A.shiftOutwards(points.B, 30) + .setText("Point C is point A shifted 3cm\nbeyond point B", "text-sm") + .attr("data-text-lineheight", 6) + + paths.direction = new Path() + .move(points.A) + .line(points.C) + .addClass("note dashed") + + macro("ld", { + from: points.C, + to: points.B, + d: -10 + }) + + return part +} +``` -```js -let { Point, points, Path, paths, macro } = part.shorthand(); - -points.A = new Point(90, 70).attr("data-text", "Point A"); -points.B = new Point(10, 10).attr("data-text", "Point B"); -points.C = points.A.shiftOutwards(points.B, 30) - .attr("data-text", "Point C is point A shifted 3cm\nbeyond point B") - .attr("data-text-lineheight", 6); - -paths.direction = new Path() - .move(points.A) - .line(points.C) - .attr("class", "note dashed"); - -macro("ld", { - from: points.C, - to: points.B, - d: -10 -}); -```