1
0
Fork 0
freesewing/sites/dev/docs/reference/api/point/readme.mdx

49 lines
917 B
Text
Raw Normal View History

---
title: Point
---
A Point object represents a point on a 2D plane with an X and Y axis.
2022-09-29 15:29:39 +02:00
## 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
2022-09-29 15:29:39 +02:00
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.
:::
2022-09-29 15:29:39 +02:00
## Example
<Example caption="Example of the Point constructor">
```js
2022-09-29 15:29:39 +02:00
({ Point, points, part }) => {
points.example = new Point(0,0)
.addCircle(10)
return part
}
```
2022-09-29 15:29:39 +02:00
</Example>
## Methods
2022-09-29 15:29:39 +02:00
A Point object exposes the following methods:
<ReadMore />