69 lines
2.2 KiB
Markdown
69 lines
2.2 KiB
Markdown
---
|
|
title: title
|
|
---
|
|
|
|
The `title` macro adds a title to a pattern part.
|
|
It is provided by the [title plugin](/reference/plugins/title).
|
|
|
|
## Signature
|
|
|
|
```js
|
|
macro('title', {
|
|
Boolean append,
|
|
Point at,
|
|
String nr,
|
|
String prefix,
|
|
Number rotation,
|
|
Number scale,
|
|
String title,
|
|
})
|
|
```
|
|
|
|
## Example
|
|
|
|
<Example caption="An example of the title macro">
|
|
```js
|
|
({ Point, Path, paths, macro, store, part }) => {
|
|
|
|
// This is where name/version/etc. is supposed to be stored
|
|
store.set('data.version', 3)
|
|
store.set('data.name', 'Example')
|
|
store.set('data.for', 'Person')
|
|
|
|
macro('title', {
|
|
nr: 9,
|
|
title: 'The title',
|
|
at: new Point(0,0)
|
|
})
|
|
|
|
// Prevent clipping
|
|
paths.diag = new Path()
|
|
.move(new Point(-20,-50))
|
|
.move(new Point(80,35))
|
|
|
|
return part
|
|
}
|
|
```
|
|
</Example>
|
|
|
|
## Configuration
|
|
|
|
| Property | Default | Type | Description |
|
|
| ----------:| :-----: | ------------------- | ----------- |
|
|
| `at` | | [Point](/reference/api/point) | The point at which to insert the title |
|
|
| `nr` | | String | The number of the pattern part |
|
|
| `title` | | String | The name of the pattern part. If title is not set or is an empty string, this won't be rendered, and the version will go beneath the nr.|
|
|
| `prefix` | | String | A prefix to add to the created points. This allow for more than 1 title per part, as long as you give them a different prefix.|
|
|
| `append` | `false` | Boolean | Set this to `true` to append the `nr` to any text already set in Point `at`'s attributes, rather than overwrite it |
|
|
| `rotation` | 0 | Number | An optional rotation in degrees |
|
|
| `scale` | 1 | Number | An optional scaling factor |
|
|
|
|
## Result
|
|
|
|
| Generated Element | Description |
|
|
|-------------------|-------------|
|
|
| `points._${prefix}_titleNr` | Point anchoring the part number text |
|
|
| `points._${prefix}_titleName` | Point anchoring the part name text |
|
|
| `points._${prefix}_titlePattern` | Point anchoring the pattern name text |
|
|
| `points._${prefix}_titleFor` | Point anchoring the name of the person for whom the pattern was made, if that information exists |
|
|
| `points._${prefix}_exportDate` | Point anchoring the pattern export date |
|