* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
40 lines
51 KiB
Markdown
40 lines
51 KiB
Markdown
---
|
|
title: "profileStartX"
|
|
excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'x' value."
|
|
layout: manual
|
|
---
|
|
|
|
Extract the provided 2-dimensional sketch's profile's origin's 'x' value.
|
|
|
|
|
|
|
|
```kcl
|
|
profileStartX(profile: [Sketch](/docs/kcl/types/Sketch)): [number](/docs/kcl/types/number)
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `profile` | [`Sketch`](/docs/kcl/types/Sketch) | Profile whose start is being used | Yes |
|
|
|
|
### Returns
|
|
|
|
[`number`](/docs/kcl/types/number)
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
sketch001 = startSketchOn(XY)
|
|
|> startProfile(at = [5, 2])
|
|
|> angledLine(angle = -26.6, length = 50)
|
|
|> angledLine(angle = 90, length = 50)
|
|
|> angledLine(angle = 30, endAbsoluteX = profileStartX(%))
|
|
```
|
|
|
|

|
|
|
|
|