chore(docs): Updated Path api docs for v3
This commit is contained in:
parent
3cb5384df5
commit
ede3c137bc
40 changed files with 1192 additions and 948 deletions
|
@ -1,42 +1,49 @@
|
|||
---
|
||||
title: reverse()
|
||||
title: Path.reverse()
|
||||
---
|
||||
|
||||
The `Path.reverse()` returns a path that is the reversed version of this path.
|
||||
As in, start becomes end, and end becomes start.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
Path path.reverse()
|
||||
Path path.reverse(bool cloneAttributes=false)
|
||||
```
|
||||
|
||||
Returns a path that is the reversed version of this path. As in, start becomes end, and end becomes start.
|
||||
If you pass a truthy value to this method, it will return a deep clone of the
|
||||
path, including its attributes. By default, it will return a shallow
|
||||
copy, whithout the attributes.
|
||||
|
||||
<Note>
|
||||
## Example
|
||||
|
||||
|
||||
<Example caption="Example of the Path.reverse() method">
|
||||
```js
|
||||
({ Point, points, Path, paths, part }) => {
|
||||
|
||||
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.example = new Path()
|
||||
.move(points.B)
|
||||
.curve(points.BCp2, points.CCp1, points.C)
|
||||
.setText("FreeSewing rocks", "text-xs fill-note center")
|
||||
|
||||
paths.reverse = paths.example.reverse(true)
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
</Example>
|
||||
|
||||
## Notes
|
||||
|
||||
The reversed path is a shallow copy.
|
||||
It will in other words not inherit the attributes of the original path.
|
||||
|
||||
If you want a deep copy, including the attributes, use `Path.clone().reverse()`.
|
||||
If you want a deep copy, including the attributes, use `Path.reverse(true)`.
|
||||
|
||||
</Note>
|
||||
|
||||
<Example part="path_reverse">
|
||||
Example of the Path.reverse() method
|
||||
</Example>
|
||||
|
||||
```js
|
||||
let { Point, points, Path, paths } = part.shorthand();
|
||||
|
||||
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.example = new Path()
|
||||
.move(points.B)
|
||||
.curve(points.BCp2, points.CCp1, points.C)
|
||||
.attr("data-text", "freesewingIsMadeByJoostDeCockAndContributors")
|
||||
.attr("data-text-class", "text-xs fill-note");
|
||||
|
||||
paths.reverse = paths.example
|
||||
.reverse()
|
||||
.attr("data-text", "freesewingIsMadeByJoostDeCockAndContributors")
|
||||
.attr("data-text-class", "text-xs fill-lining");
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue