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

57 lines
1.3 KiB
Text
Raw Normal View History

---
2022-09-22 09:05:20 +02:00
title: Path.attr()
---
2022-09-22 09:05:20 +02:00
This `Path.attr()` method can be used to add attributes to the Path object.
It calls `this.attributes.add()` under the hood, and returns the Path object.
If the optional third parameter is set to `true` it will call `this.attributes.set()`
2022-09-22 09:05:20 +02:00
instead, thereby overwriting the value of the attribute.
## Signature
```js
Path path.attr(
string name,
mixed value,
bool overwrite = false
)
```
:::tipThis method is chainable as it returns the `Path` object:::
## Example
<Example caption=" Example of the Path.attr() method">
```js
2022-09-22 09:05:20 +02:00
({ Point, points, Path, paths, part }) => {
2022-09-29 17:50:53 +02:00
points.from = new Point(10, 20)
points.cp1 = new Point(20, -10)
points.cp2 = new Point(50, 50)
points.to = new Point(70, 20)
2022-09-22 09:05:20 +02:00
paths.example = new Path()
.move(points.from)
.curve(points.cp1, points.cp2, points.to)
.attr("class", "canvas")
.setText("FreeSewing rocks", "text-xs center")
2022-09-22 09:05:20 +02:00
return part
}
```
</Example>
2022-09-22 09:05:20 +02:00
## Notes
2022-09-22 09:05:20 +02:00
Methods like
[`Path.addClass`](/reference/api/path/addclass),
[`Path.setClass`](/reference/api/path/setclass),
[`Path.addText`](/reference/api/path/addtext), and
[`Path.setText`](/reference/api/path/settext)
2022-09-22 09:05:20 +02:00
all call this method under the hood.
See [Using Attributes](/howtos/code/attributes)
for information about custom Attributes that can be used with Paths.