ed8a166ea9
This PR reverts the incorrect lint/prettier changes applied to <Example> code in the reference Core API docs l by the husky pre-commit hook, the problem mentioned in Issue #333. (These are just the changes for the Core API docs. Additional PRs will be filed for changes in the other reference, howtos, and guides documentation.) Co-authored-by: Benjamin Fan <ben-git@swinglonga.com> Reviewed-on: https://codeberg.org/freesewing/freesewing/pulls/367 Reviewed-by: Joost De Cock <joostdecock@noreply.codeberg.org> Co-authored-by: Benjamin Fan <benjamesben@noreply.codeberg.org> Co-committed-by: Benjamin Fan <benjamesben@noreply.codeberg.org> |
||
|---|---|---|
| .. | ||
| addcircle | ||
| addtext | ||
| angle | ||
| asrenderprops | ||
| attr | ||
| clone | ||
| copy | ||
| dist | ||
| dx | ||
| dy | ||
| flipx | ||
| flipy | ||
| rotate | ||
| setcircle | ||
| settext | ||
| shift | ||
| shiftfractiontowards | ||
| shiftoutwards | ||
| shifttowards | ||
| sitson | ||
| sitsroughlyon | ||
| slope | ||
| translate | ||
| readme.mdx | ||
---
title: Point
---
A Point object represents a point on a 2D plane with an X and Y axis.
## Signature
```js
Point new Point(Number x, Number y)
```
The point constructor takes two arguments:
- `x` : The X-coordinate of the point
- `y` : The Y-coordinate of the point
## Properties
Point objects come with the following properties:
- `x` : The X-coordinate of the point
- `y` : The Y-coordinate of the point
- `attributes` : An [Attributes](/reference/api/attributes) instance holding the point's attributes
:::note RELATED
See [Using Attributes](/howtos/code/attributes)
for information about custom Attributes that can be used with Points.
:::
## Example
<Example caption="Example of the Point constructor">
```js
({ Point, points, part }) => {
points.example = new Point(0,0)
.addCircle(10)
return part
}
```
</Example>
## Methods
A Point object exposes the following methods:
<ReadMore />