Files
modeling-app/docs/kcl/profileStartX.md
Nick Cameron c050739f41 Some improvements to the boxed signatures in the docs (#6593)
* 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>
2025-04-30 16:03:22 +00:00

51 KiB

title, excerpt, layout
title excerpt layout
profileStartX Extract the provided 2-dimensional sketch's profile's origin's 'x' value. manual

Extract the provided 2-dimensional sketch's profile's origin's 'x' value.

profileStartX(profile: [Sketch](/docs/kcl/types/Sketch)): [number](/docs/kcl/types/number)

Arguments

Name Type Description Required
profile Sketch Profile whose start is being used Yes

Returns

number

Examples

sketch001 = startSketchOn(XY)
  |> startProfile(at = [5, 2])
  |> angledLine(angle = -26.6, length = 50)
  |> angledLine(angle = 90, length = 50)
  |> angledLine(angle = 30, endAbsoluteX = profileStartX(%))

Rendered example of profileStartX 0