1.6 KiB
1.6 KiB
title |
---|
vd |
The vd
macro adds a vertical dimension to your pattern.
It is provided by the dimension plugin.
Signature
macro('vd', {
String id,
Point from,
Boolean noEndtMarker,
Boolean noStartMarker,
String text,
Point to,
Number x,
})
Example
```js ({ Point, macro, part }) => {macro('vd', { from: new Point(0,0), to: new Point(0,40), x:10, })
return part }
</Example>
## Configuration
| Property | Default | Type | Description |
|----------------:|---------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint of the dimension |
| `to` | | [Point](/reference/api/point) | The endpoint of the dimension |
| `x` | | Number | The X-value at which to draw the dimension |
| `text` | Vertical distance | Number | The text to go on the dimension if not the from-to vertical distance |
| `id` | auto-assigned | String | A custom ID under wich paths and points will be created |
| `noStartMarker` | `false` | Boolean | Whether to not draw a start marker |
| `noEndMarker` | `false` | Boolean | Whether to not draw an end marker |
## Notes
Setting a custom ID will:
- Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
- Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)