VSinerva/freesewing
1
0
Fork 0
Code Activity

feat(markdown): New docs for various things

Browse source
This commit is contained in:
joostdecock 2023-10-29 17:20:35 +01:00
parent 9fe93e03ce
commit 6b147d81a0
93 changed files with 1274 additions and 589 deletions
Download patch file Download diff file Expand all files Collapse all files

35
markdown/dev/reference/macros/rmringsector/en.md
View file

@ -1,5 +1,5 @@
---
title: rmringsector
title: rmRingSector
---
The `rmringsector` macro removes the nodes added by [the ringsector macro](/reference/macros/ringsector).
@ -21,36 +21,3 @@ if you want to use it.
macro('rmringsector', String id = 'ringsector')
```
## Example
<Example caption="Example of a ring sector removed by this macro">
```js
({ Point, macro, Path, paths, part }) => {
macro('ringsector', {
angle: 60,
insideRadius: 30,
outsideRadius: 45,
})
macro('rmringsector')
return part
}
```
</Example>
## Configuration
| Property | Default | Type | Description |
|---------:|--------------|--------|-------------|
| `id` | `ringsector` | String | The id of the ringsector macro to remove |
## Notes
### Nodes removed by this macro
This macro will remove points and a single path from your part.
Their IDs have been saved in store under:
`parts.{part.name}.macros.@freesewing/plugin-ringsector.ids.{id}`
by the [the ringsector macro](/reference/macros/ringsector).