1
0
Fork 0
freesewing/sites/dev/docs/reference/api/path/addtext
2024-09-29 07:14:59 +02:00
..
readme.mdx fix(dev): One-liner admonitions 2024-09-29 07:14:59 +02:00

---
title: Path.addText()
---

The `Path.addText()` method adds text to the path.

## Signature

```js
Path path.addText(string text, string className = '')
```

The second argument will optionally be used to set the CSS class for the text.

:::tip
This method is chainable as it returns the `Path` object
:::

## Example

<Example caption="Example of the Path.addText() method">
```js
({ Point, points, Path, paths, part }) => {
  points.from = new Point(5, 10)
  points.to = new Point(95, 10)

paths.line = new Path()
.move(points.from)
.line(points.to)
.addText('FreeSewing rocks')

return part
}

````
</Example>

## Notes

The main purpose of this method is to save your some typing,
as the two following calls yield the same result:

```js
path.attr('data-text', 'Hello')
path.addText('Hello')
````

The difference with [Path.setText()](/reference/api/path/addtext) is that this
method will add to the existing text whereas `Path.setText()` will overwrite
existing text on the path,