VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Updated Point.setCircle() docs

Browse source
This commit is contained in:
Joost De Cock 2022-09-29 16:05:27 +02:00
parent 2532544758
commit a40b01de52
1 changed files with 12 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
markdown/dev/reference/api/point/setcircle/en.md
View file

@ -2,14 +2,17 @@
title: Point.setCircle()
---
Sets a circle to a Point. Behaves the same as [addCircle](/reference/api/points/addcircle) but
the different is that it will overwrite any previous circle set.
The `Point.setCircle()` method adds a circle to a Point. It yields similar
results as the [`Point.addCircle()`](/reference/api/points/addcircle) method,
the different is that `Point.setCircle()` will overwrite any previous circle
set.
Essentially, it mimics the difference between adding vs setting an attribute.
Refer to [Drawing circles](/howtos/code/drawing-circles) for more details on how circles are handled.
Refer to [Drawing circles](/howtos/code/drawing-circles) for more details on
how circles are handled.
## Point.setCircle() signature
## Signature
```js
Point point.setCircle(
@ -18,14 +21,12 @@ Point point.setCircle(
)
```
## Point.setCircle() example
<Example part="point_setcircle">
Examples of Point.setCircle(), compare this to [Point.addCircle](/reference/api/point/addcircle)
</Example>
## Example
<Example caption="Examples of Point.setCircle(), compare this to [Point.addCircle](/reference/api/point/addcircle)">
```js
({ Point, points, part }) => {
points.a = new Point(30, 10)
.setCircle(3, 'lining dashed')
.setCircle(7, 'mark dashed')
@ -44,4 +45,6 @@ Examples of Point.setCircle(), compare this to [Point.addCircle](/reference/api/
return part
}
```
</Example>