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>
49 lines
1,003 B
Text
49 lines
1,003 B
Text
---
|
|
title: Path.setText()
|
|
---
|
|
|
|
The `Path.setText()` method sets text on the path.
|
|
|
|
## Signature
|
|
|
|
```js
|
|
Path path.setText(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.setText() 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)
|
|
.setText('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.setText('Hello')
|
|
```
|
|
|
|
The difference with [Path.addText()](/reference/api/path/addtext) is that this
|
|
method will overwrite existing text on the path, whereas `Path.addText()` will
|
|
add to the existing text.
|