chore(markdown): Restructuring dev docs
This commit is contained in:
parent
9ef46c502a
commit
d42d9a9377
114 changed files with 246 additions and 1462 deletions
40
markdown/dev/reference/api/macros/ld/en.md
Normal file
40
markdown/dev/reference/api/macros/ld/en.md
Normal file
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: ld
|
||||
---
|
||||
|
||||
The `ld` macro adds a *linear dimension* to your pattern.
|
||||
It is provided by the [dimension plugin](/reference/plugins/dimension/).
|
||||
|
||||
<Example
|
||||
part="point_dist"
|
||||
caption="An example of a linear dimension"
|
||||
/>
|
||||
|
||||
```js
|
||||
macro('ld', {
|
||||
from: points.from,
|
||||
to: points.to,
|
||||
d: 0
|
||||
})
|
||||
```
|
||||
|
||||
|
||||
| Property | Default | Type | Description |
|
||||
|-----------------|---------|---------------------|-------------|
|
||||
| `from` | | [Point](/reference/api/point) | The startpoint of the dimension |
|
||||
| `to` | | [Point](/reference/api/point) | The endpoint of the dimension |
|
||||
| `d` | 0 | Number | The offset at which to draw the dimension |
|
||||
| `id` | auto-assigned | String | A custom ID under wich paths and points will be created |
|
||||
| `text` | Linear distance | Number | The text to go on the dimension if not the from-to linear distance |
|
||||
| `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>
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue