aea82e004a
Previously, `xLine`, `xLineTo`, `yLine` and `yLineTo` used positional arguments. Now: - `xLineTo` and `yLineTo` have been removed - `xLine` and `yLine` both use keyword arguments: - `length`, optional (i.e. a relative distance along the X or Y axis) - `endAbsolute` optional (i.e. an absolute point along the X or Y axis) - `tag` optional - Exactly one of `length` or `endAbsolute` must be given. Not both, not neither. For example: ``` // Old way |> xLine(6.04, %) |> yLineTo(20, %, $base) // New way |> xLine(length = 6.04) |> yLine(endAbsolute = 20, tag = $base) ``` This also improves some of the general-purpose keyword arguments code in modeling app's TS codebase.
52 lines
89 KiB
Markdown
52 lines
89 KiB
Markdown
---
|
|
title: "yLine"
|
|
excerpt: "Draw a line relative to the current origin to a specified distance away from the current position along the 'y' axis."
|
|
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(
|
|
sketch: Sketch,
|
|
length?: number,
|
|
endAbsolute?: number,
|
|
tag?: TagDeclarator,
|
|
): Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
|
|
| `length` | [`number`](/docs/kcl/types/number) | How far away along the Y axis should this line go? Incompatible with `endAbsolute`. | No |
|
|
| `endAbsolute` | [`number`](/docs/kcl/types/number) | Which absolute Y value should this line go to? Incompatible with `length`. | No |
|
|
| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> startProfileAt([0, 0], %)
|
|
|> yLine(length = 15)
|
|
|> angledLine({ angle = 30, length = 15 }, %)
|
|
|> line(end = [8, -10])
|
|
|> yLine(length = -5)
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
```
|
|
|
|
|
|
|
|
|