35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
---
|
|
title: pd
|
|
---
|
|
|
|
The `pd` macro adds a _path dimension_ to your pattern, indicating the length of a path.\
|
|
It is provided by the [dimension plugin](/reference/plugins/dimension/).
|
|
|
|
<Example part="path_length">
|
|
Example of a multiple path dimensions
|
|
</Example>
|
|
|
|
```js
|
|
macro('pd', {
|
|
path: paths.example,
|
|
d: -20
|
|
})
|
|
```
|
|
|
|
| Property | Default | Type | Description |
|
|
|----------------:|---------|---------------------|-------------|
|
|
| `path` | | [Path](/reference/api/path) | The path to draw the dimension along |
|
|
| `d` | 0 | Number | The offset at which to draw the dimension |
|
|
| `text` | Path length | Number | The text to go on the dimension if not the length of the path |
|
|
| `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 |
|
|
|
|
<Note>
|
|
|
|
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/)
|
|
|
|
</Note>
|