0621e1a53e
* Add documentation to modules, and some constants and types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Improve the language reference Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
39 lines
38 KiB
Markdown
39 lines
38 KiB
Markdown
---
|
|
title: "profileStartY"
|
|
subtitle: "Function in std::sketch"
|
|
excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y' value."
|
|
layout: manual
|
|
---
|
|
|
|
Extract the provided 2-dimensional sketch's profile's origin's 'y' value.
|
|
|
|
```kcl
|
|
profileStartY(@profile: Sketch): number
|
|
```
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `profile` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Profile whose start is being used | Yes |
|
|
|
|
### Returns
|
|
|
|
[`number`](/docs/kcl-std/types/std-types-number) - A number.
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
sketch001 = startSketchOn(XY)
|
|
|> startProfile(at = [5, 2])
|
|
|> angledLine(angle = -60, length = 14)
|
|
|> angledLine(angle = 30, endAbsoluteY = profileStartY(%))
|
|
```
|
|
|
|
|
|
|
|
|