2021-10-17 18:26:00 +02:00
|
|
|
---
|
|
|
|
title: vd
|
|
|
|
---
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2022-08-27 21:49:14 +02:00
|
|
|
The `vd` macro adds a _vertical dimension_ to your pattern.
|
2021-08-25 16:09:31 +02:00
|
|
|
It is provided by the [dimension plugin](/reference/plugins/dimension/).
|
|
|
|
|
2022-09-30 04:39:30 +02:00
|
|
|
## Signature
|
2021-08-25 16:09:31 +02:00
|
|
|
|
|
|
|
```js
|
|
|
|
macro('vd', {
|
2022-09-30 04:39:30 +02:00
|
|
|
String id,
|
|
|
|
Point from,
|
|
|
|
Boolean noEndtMarker,
|
|
|
|
Boolean noStartMarker,
|
|
|
|
String text,
|
|
|
|
Point to,
|
|
|
|
Number x,
|
2021-08-25 16:09:31 +02:00
|
|
|
})
|
|
|
|
```
|
|
|
|
|
2022-09-30 04:39:30 +02:00
|
|
|
## Example
|
|
|
|
|
|
|
|
<Example caption="An example of a vertical dimension with the vd macro">
|
|
|
|
```js
|
|
|
|
({ Point, macro, part }) => {
|
|
|
|
|
|
|
|
macro('vd', {
|
|
|
|
from: new Point(0,0),
|
|
|
|
to: new Point(0,40),
|
|
|
|
x:10,
|
|
|
|
})
|
|
|
|
|
|
|
|
return part
|
|
|
|
}
|
|
|
|
```
|
|
|
|
</Example>
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
2022-02-19 08:04:25 +01:00
|
|
|
| Property | Default | Type | Description |
|
2021-08-25 16:09:31 +02:00
|
|
|
|----------------:|---------|---------------------|-------------|
|
|
|
|
| `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 |
|
|
|
|
|
2022-09-30 04:39:30 +02:00
|
|
|
## Notes
|
2021-08-25 16:09:31 +02:00
|
|
|
|
|
|
|
Setting a custom ID will:
|
|
|
|
|
2022-02-20 14:44:38 +01:00
|
|
|
- Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
|
|
|
|
- Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
|