46 lines
88 KiB
Markdown
46 lines
88 KiB
Markdown
---
|
|
title: "yLine"
|
|
excerpt: "Draw a line relative to the current origin to a specified distance away"
|
|
layout: manual
|
|
---
|
|
|
|
Draw a line relative to the current origin to a specified distance away
|
|
|
|
from the current position along the 'y' axis.
|
|
|
|
```js
|
|
yLine(length: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `length` | `number` | | Yes |
|
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn('XZ')
|
|
|> startProfileAt([0, 0], %)
|
|
|> yLine(15, %)
|
|
|> angledLine({ angle = 30, length = 15 }, %)
|
|
|> line(end = [8, -10])
|
|
|> yLine(-5, %)
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
```
|
|
|
|
|
|
|
|
|