modeling-app/docs/kcl/map.md

title, excerpt, layout

title	excerpt	layout
map	Apply a function to every element of a list.	manual

Apply a function to every element of a list.

Given a list like [a, b, c], and a function like f, returns [f(a), f(b), f(c)]

map(array: [KclValue], map_fn: FunctionSource) -> [KclValue]

Arguments

Name	Type	Description	Required
array	[KclValue]		Yes
map_fn	FunctionSource		Yes

Returns

[KclValue]

Examples

r = 10 // radius
fn drawCircle(id) {
  return startSketchOn("XY")
    |> circle({ center = [id * 2 * r, 0], radius = r }, %)
}

// Call `drawCircle`, passing in each element of the array.
// The outputs from each `drawCircle` form a new array,
// which is the return value from `map`.
circles = map([1..3], drawCircle)

r = 10 // radius
// Call `map`, using an anonymous function instead of a named one.
circles = map([1..3], fn(id) {
  return startSketchOn("XY")
    |> circle({ center = [id * 2 * r, 0], radius = r }, %)
})