VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(docs): Updated Path api docs for v3

Browse source
This commit is contained in:
Joost De Cock 2022-09-27 18:24:35 +02:00
parent 3cb5384df5
commit ede3c137bc
40 changed files with 1192 additions and 948 deletions
Download patch file Download diff file Expand all files Collapse all files

71
markdown/dev/reference/api/path/join/en.md
View file

@ -1,44 +1,49 @@
---
title: join()
title: Path.join()
---
The `Path.join()` method joins this path with another path.
## Signature
```js
Path path.join(path other)
```
Joins this path with another path.
## Examples
<Warning>
<Example caption="Example of the Path.join() method">
```js
({ Point, points, Path, paths, part }) => {
points.A = new Point(45, 60)
points.B = new Point(10, 30)
points.BCp2 = new Point(40, 20)
points.C = new Point(90, 30)
points.CCp1 = new Point(50, -30)
paths.path1 = new Path()
.move(points.A)
.line(points.B)
.setClass("various")
paths.path2 = new Path()
.move(points.B)
.curve(points.BCp2, points.CCp1, points.C)
.setClass("note")
paths.joint = paths.path1
.join(paths.path2)
.setClass("lining dotted")
return part
}
```
</Example>
## Notes
You cannot join a closed path to another path
</Warning>
<Example part="path_join">
Example of the Path.join() method
</Example>
```js
let { Point, points, Path, paths } = part.shorthand();
points.A = new Point(45, 60);
points.B = new Point(10, 30);
points.BCp2 = new Point(40, 20);
points.C = new Point(90, 30);
points.CCp1 = new Point(50, -30);
paths.path1 = new Path()
.move(points.A)
.line(points.B)
.attr("class", "various");
paths.path2 = new Path()
.move(points.B)
.curve(points.BCp2, points.CCp1, points.C)
.attr("class", "canvas");
paths.joint = paths.path1
.join(paths.path2)
.attr("class", "note lashed stroke-l")
.attr("style", "stoke-opacity: 0.5");
```