1
0
Fork 0
freesewing/markdown/dev/reference/macros/bartackalong/en.md
2023-10-29 17:20:35 +01:00

1.9 KiB

title
bartackAlong

The bartackAlong macro allows you to add a bartack marker to your sewing pattern. More specifically, a bartack along a path.

It is provided by plugin-annotations, which is part of core-plugins (so it is available by default).

Signature

macro('bartackAlong', {
  String id='bartack'
  Number angle=0,
  Number density=3,
  Number length=15,
  Path path,
  String prefix='',
  String suffix='',
  Number width=3,
  Boolean force = false,
})

Example

```js ({ Point, Path, macro, part }) => {

macro('bartackAlong', { path: new Path() .move(new Point(15,15)) .curve( new Point(20, 20), new Point(30, 20), new Point(35, 15), ) })

return part }

</Example>

## Configuration

| Property     | Default    | Type       | Description |
|-------------:|------------|------------|-------------|
| `angle`      | `0`        | `number`   | The angle under which to draw the bartack |
| `density`    | `3`        | `number`   | Controls how close the stitches are together |
| `id`         | `bartackalong` | `string` | The ID of this macro instance |
| `length`     | `15`       | `number`   | Length of the bartack |
| `path`       |            | `Path`     | The path the bartack should follow |
| `prefix`     |            | `string`   | A prefix to apply to the name of the generated path |
| `suffix`     |            | `string`   | A suffix to apply to the name of the generated path |
| `width`      | `3`        | `number`   | Width of the bartack |
| `force`      | `false`    | `boolean`  | Set this to `true` to display the macro output even when `complete` is `false` |

## Notes

This macro takes the `complete` setting into account and won't output anything when both complete and `force` are `false`.