feat(markdown): Added docs for new core methods
This commit is contained in:
parent
714c4ae368
commit
28bccbaaf9
2 changed files with 76 additions and 0 deletions
38
markdown/dev/reference/api/snippet/rotate/en.md
Normal file
38
markdown/dev/reference/api/snippet/rotate/en.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Snippet.rotate()
|
||||
---
|
||||
|
||||
The `Snippet.rotate()` method allows you to scale a snippet. Under the hood, it
|
||||
sets the `data-rotate` property.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
Snippet snippet.rotate(rotation, overwrite=true)
|
||||
```
|
||||
|
||||
<Tip compact>This method is chainable as it returns the `Snippet` object</Tip>
|
||||
|
||||
## Example
|
||||
|
||||
<Example caption="An example of the Snippet.rotate() method">
|
||||
```js
|
||||
({ Point, Path, paths, Snippet, snippets, part }) => {
|
||||
|
||||
for (const i of [0,1,2,3,4,5,6]) {
|
||||
snippets[`demo${i}`] = new Snippet(
|
||||
"logo",
|
||||
new Point(60*i, 0)
|
||||
).rotate(60 * i)
|
||||
}
|
||||
|
||||
// Prevent clipping
|
||||
paths.diag = new Path()
|
||||
.move(new Point(-30,-50))
|
||||
.move(new Point(400,50))
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
</Example>
|
||||
|
38
markdown/dev/reference/api/snippet/scale/en.md
Normal file
38
markdown/dev/reference/api/snippet/scale/en.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Snippet.scale()
|
||||
---
|
||||
|
||||
The `Snippet.scale()` method allows you to scale a snippet. Under the hood, it
|
||||
sets the `data-scale` property.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
Snippet snippet.scale(scale, overwrite=true)
|
||||
```
|
||||
|
||||
<Tip compact>This method is chainable as it returns the `Snippet` object</Tip>
|
||||
|
||||
## Example
|
||||
|
||||
<Example caption="An example of the Snippet.clone() method">
|
||||
```js
|
||||
({ Point, Path, paths, Snippet, snippets, part }) => {
|
||||
|
||||
for (const i of [1,2,3,4,5,6]) {
|
||||
snippets[`demo${i}`] = new Snippet(
|
||||
"logo",
|
||||
new Point(30*i, 0)
|
||||
).scale(i/10)
|
||||
}
|
||||
|
||||
// Prevent clipping
|
||||
paths.diag = new Path()
|
||||
.move(new Point(0,-30))
|
||||
.move(new Point(200,20))
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
</Example>
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue