• 
• 
• Reference
• 
• Foundations
• 
• Arguments

转到官方文档（英文）

arguments自始可用

Captured arguments to a function.

Arguments are either positional or named, and can be accessed through the pos, named, and at methods.

Additionally, named arguments can be accessed with field syntax similar to dictionaries.

Argument Sinks

Like built-in functions, custom functions can also take a variable number of arguments. You can specify an argument sink which collects all excess arguments as ..sink. The resulting sink value is of the arguments type. It exposes methods to access the positional and named arguments.

#let format(title, ..authors) = {
  let by = authors
    .pos()
    .join(", ", last: " and ")

  [*#title* \ _Written by #by;_]
}

#format("ArtosFlow", "Jane", "Joe")

Spreading

Inversely to an argument sink, you can spread arguments, arrays and dictionaries into a function call with the ..spread operator:

#let array = (2, 3, 5)
#calc.min(..array)
#let dict = (fill: blue)
#text(..dict)[Hello]

构造函数

若某类型提供构造函数，可调用它生成该类型的新实例。

Construct spreadable arguments in place.

This function behaves like let args(..sink) = sink.

展开示例

#let args = arguments(stroke: red, inset: 1em, [Body])
#box(..args)

arguments

any

必需参数

必需参数在调用函数时必须传入。

位置参数

位置参数按顺序传入，不带参数名。

变长参数

变长参数可以传入多次。

The arguments to construct.

函数

这些函数和类型带有附属函数。要访问这种函数，请先写上函数或类型的名称，再加上附属函数的名称，并用句点在中间分隔。

len0.15.0起可用

The number of arguments, positional or named.

at0.12.0起可用

Returns the positional argument at the specified index, or the named argument with the specified name.

If the key is an integer, this is equivalent to first calling pos and then array.at. If it is a string, this is equivalent to first calling named and then dictionary.at.

Named arguments can also be accessed with field syntax (e.g. arguments(key: 42).key) if no default is needed. Unlike dictionaries, fields on arguments cannot be modified.

key

int or str

必需参数

必需参数在调用函数时必须传入。

位置参数

位置参数按顺序传入，不带参数名。

The index or name of the argument to get.

default

any

A default value to return if the key is invalid.

pos自始可用

Returns the captured positional arguments as an array.

named自始可用

Returns the captured named arguments as a dictionary.

filter0.15.0起可用

Produces a new arguments with only the arguments for which the value passes the test.

展开示例

#{
  arguments(-1, a: 0, b: 1, 2)
    .filter(v => v > 0)
}

test

function

必需参数

必需参数在调用函数时必须传入。

位置参数

位置参数按顺序传入，不带参数名。

The function to apply to each value. Must return a boolean.

map0.15.0起可用

Produces a new arguments by transforming each argument value with the passed function.

展开示例

#{
  arguments(0, a: 1, 2)
    .map(v => v + 1)
}

mapper

function

必需参数

必需参数在调用函数时必须传入。

位置参数

位置参数按顺序传入，不带参数名。

The function to apply to each value.

转到官方文档（英文）

Foundations上一页

Array下一页