
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>
45 lines
934 B
Text
45 lines
934 B
Text
---
|
|
title: Point.addText()
|
|
---
|
|
|
|
The `Point.addText()` method adds text on a Point. Under the hood, this will
|
|
call `Point.attr()` as text is added by setting attributes. Refer to [Adding
|
|
text](/howtos/code/adding-text) for more details.
|
|
|
|
## Signature
|
|
|
|
```js
|
|
Point point.addText(
|
|
string text,
|
|
string className
|
|
)
|
|
```
|
|
|
|
:::tip
|
|
This method is chainable as it returns the `Point` object
|
|
:::
|
|
|
|
## Example
|
|
|
|
<Example caption="Examples of Point.addText(), compare this to [Point.setText](/reference/api/point/settext)">
|
|
```js
|
|
({ Point, points, Path, paths, part }) => {
|
|
points.anchor = new Point(100, 25)
|
|
.addText('FreeSewing')
|
|
.addText('rocks')
|
|
|
|
// Avoid the text getting cropped
|
|
paths.hidden = new Path()
|
|
.move(points.anchor)
|
|
.line(points.anchor.shift(0, 80))
|
|
.addClass('hidden')
|
|
|
|
|
|
return part
|
|
}
|
|
```
|
|
</Example>
|
|
|
|
## Notes
|
|
|
|
Remember to [use translation keys, not text](/guides/best-practices#use-translation-keys)
|