InfoThis site is generated using the static site generator developed by the Typst Community. Please adjust the text content of this banner according to your usage requirements. At Typst GmbH's request, when publishing documentation, you must clearly indicate that it is non-official and display the version of Typst being documented. For details, refer to Issue #874 on typst/typst.
TypstDocumentEnglish
v0.13.1
Open official docs

array

A sequence of values.

You can construct an array by enclosing a comma-separated sequence of values in parentheses. The values do not have to be of the same type.

You can access and update array items with the .at() method. Indices are zero-based and negative indices wrap around to the end of the array. You can iterate over an array using a for loop. Arrays can be added together with the + operator, joined together and multiplied with integers.

Note: An array of length one needs a trailing comma, as in (1,). This is to disambiguate from a simple parenthesized expressions like (1 + 2) * 3. An empty array is written as ().

Example

#let values = (1, 7, 4, -3, 2)

#values.at(0) \
#(values.at(0) = 3)
#values.at(-1) \
#values.find(calc.even) \
#values.filter(calc.odd) \
#values.map(calc.abs) \
#values.rev() \
#(1, (2, 3)).flatten() \
#(("A", "B", "C")
    .join(", ", last: " and "))
Preview

Constructor
Parameter
Parameters are input values for functions. Specify them in parentheses after the function name.

Converts a value to an array.

Note that this function is only intended for conversion of a collection-like value to an array, not for creation of an array from individual items. Use the array syntax (1, 2, 3) (or (1,) for a single-element array) instead.

#let hi = "Hello 😃"
#array(bytes(hi))
Preview
array(
bytesarrayversion
)->
array

value
bytesarrayversion
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The value that should be converted to an array.

Definitions
Definitions
These functions and types can have related definitions. To access a definition, specify the name of the function or type, followed by the definition name separated by a period.

len

The number of values in the array.

self.len()->
int

first

Returns the first item in the array. May be used on the left-hand side of an assignment. Fails with an error if the array is empty.

self.first()->
any

last

Returns the last item in the array. May be used on the left-hand side of an assignment. Fails with an error if the array is empty.

self.last()->
any

at

Returns the item at the specified index in the array. May be used on the left-hand side of an assignment. Returns the default value if the index is out of bounds or fails with an error if no default value was specified.

self.at(
int
,
default:
any
)->
any

index
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The index at which to retrieve the item. If negative, indexes from the back.

default
any

A default value to return if the index is out of bounds.

push

Adds a value to the end of the array.

self.push(
any
)

value
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The value to insert at the end of the array.

pop

Removes the last item from the array and returns it. Fails with an error if the array is empty.

self.pop()->
any

insert

Inserts a value into the array at the specified index, shifting all subsequent elements to the right. Fails with an error if the index is out of bounds.

To replace an element of an array, use at.

self.insert(
int
,
any
)

index
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The index at which to insert the item. If negative, indexes from the back.

value
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The value to insert into the array.

remove

Removes the value at the specified index from the array and return it.

self.remove(
int
,
default:
any
)->
any

index
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The index at which to remove the item. If negative, indexes from the back.

default
any

A default value to return if the index is out of bounds.

slice

Extracts a subslice of the array. Fails with an error if the start or end index is out of bounds.

self.slice(
int
,
noneint
,
count:
int
)->
array

start
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The start index (inclusive). If negative, indexes from the back.

end
noneint
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The end index (exclusive). If omitted, the whole slice until the end of the array is extracted. If negative, indexes from the back.

Default value:
none

count
int

The number of items to extract. This is equivalent to passing start + count as the end position. Mutually exclusive with end.

contains

Whether the array contains the specified value.

This method also has dedicated syntax: You can write 2 in (1, 2, 3) instead of (1, 2, 3).contains(2).

self.contains(
any
)->
bool

value
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The value to search for.

find

Searches for an item for which the given function returns true and returns the first match or none if there is no match.

self.find(
function
)->
anynone

searcher
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

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

position

Searches for an item for which the given function returns true and returns the index of the first match or none if there is no match.

self.position(
function
)->
noneint

searcher
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

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

range

Create an array consisting of a sequence of numbers.

If you pass just one positional parameter, it is interpreted as the end of the range. If you pass two, they describe the start and end of the range.

This function is available both in the array function's scope and globally.

Show example
#range(5) \
#range(2, 5) \
#range(20, step: 4) \
#range(21, step: 4) \
#range(5, 2, step: -1)
Preview
array.range(
int
,
int
,
step:
int
)->
array

start
int
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The start of the range (inclusive).

Default value:
0

end
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The end of the range (exclusive).

step
int

The distance between the generated numbers.

Default value:
1

filter

Produces a new array with only the items from the original one for which the given function returns true.

self.filter(
function
)->
array

test
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

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

map

Produces a new array in which all items from the original one were transformed with the given function.

self.map(
function
)->
array

mapper
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The function to apply to each item.

enumerate

Returns a new array with the values alongside their indices.

The returned array consists of (index, value) pairs in the form of length-2 arrays. These can be destructured with a let binding or for loop.

self.enumerate(
start:
int
)->
array

start
int

The index returned for the first pair of the returned list.

Default value:
0

zip

Zips the array with other arrays.

Returns an array of arrays, where the ith inner array contains all the ith elements from each original array.

If the arrays to be zipped have different lengths, they are zipped up to the last element of the shortest array and all remaining elements are ignored.

This function is variadic, meaning that you can zip multiple arrays together at once: (1, 2).zip(("A", "B"), (10, 20)) yields ((1, "A", 10), (2, "B", 20)).

self.zip(
exact:
bool
,
array
)->
array

exact
bool

Whether all arrays have to have the same length. For example, (1, 2).zip((1, 2, 3), exact: true) produces an error.

Default value:
false

others
array
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.
Variadic
Variadic
Variadic parameters can be specified multiple times.

The arrays to zip with.

fold

Folds all items into a single value using an accumulator function.

self.fold(
any
,
function
)->
any

init
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The initial value to start with.

folder
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The folding function. Must have two parameters: One for the accumulated value and one for an item.

sum

Sums all items (works for all types that can be added).

self.sum(
default:
any
)->
any

default
any

What to return if the array is empty. Must be set if the array can be empty.

product

Calculates the product all items (works for all types that can be multiplied).

self.product(
default:
any
)->
any

default
any

What to return if the array is empty. Must be set if the array can be empty.

any

Whether the given function returns true for any item in the array.

self.any(
function
)->
bool

test
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

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

all

Whether the given function returns true for all items in the array.

self.all(
function
)->
bool

test
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

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

flatten

Combine all nested arrays into a single flat one.

self.flatten()->
array

rev

Return a new array with the same items, but in reverse order.

self.rev()->
array

split

Split the array at occurrences of the specified value.

self.split(
any
)->
array

at
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The value to split at.

join

Combine all items in the array into one.

self.join(
anynone
,
last:
any
)->
any

separator
anynone
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

A value to insert between each item of the array.

Default value:
none

last
any

An alternative separator between the last two items.

intersperse

Returns an array with a copy of the separator value placed between adjacent elements.

self.intersperse(
any
)->
array

separator
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The value that will be placed between each adjacent element.

chunks

Splits an array into non-overlapping chunks, starting at the beginning, ending with a single remainder chunk.

All chunks but the last have chunk-size elements. If exact is set to true, the remainder is dropped if it contains less than chunk-size elements.

Show example
#let array = (1, 2, 3, 4, 5, 6, 7, 8)
#array.chunks(3) \
#array.chunks(3, exact: true)
Preview
self.chunks(
int
,
exact:
bool
)->
array

chunk-size
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

How many elements each chunk may at most contain.

exact
bool

Whether to keep the remainder if its size is less than chunk-size.

Default value:
false

windows

Returns sliding windows of window-size elements over an array.

If the array length is less than window-size, this will return an empty array.

Show example
#let array = (1, 2, 3, 4, 5, 6, 7, 8)
#array.windows(5)
Preview
self.windows(
int
)->
array

window-size
int
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

How many elements each window will contain.

sorted

Return a sorted version of this array, optionally by a given key function. The sorting algorithm used is stable.

Returns an error if two values could not be compared or if the key function (if given) yields an error.

To sort according to multiple criteria at once, e.g. in case of equality between some criteria, the key function can return an array. The results are in lexicographic order.

Show example
#let array = (
  (a: 2, b: 4),
  (a: 1, b: 5),
  (a: 2, b: 3),
)
#array.sorted(key: it => (it.a, it.b))
Preview
self.sorted(
key:
function
)->
array

key
function

If given, applies this function to the elements in the array to determine the keys to sort by.

dedup

Deduplicates all items in the array.

Returns a new array with all duplicate items removed. Only the first element of each duplicate is kept.

Show example
#(1, 1, 2, 3, 1).dedup()
Preview
self.dedup(
key:
function
)->
array

key
function

If given, applies this function to the elements in the array to determine the keys to deduplicate by.

to-dict

Converts an array of pairs into a dictionary. The first value of each pair is the key, the second the value.

If the same key occurs multiple times, the last value is selected.

Show example
#(
  ("apples", 2),
  ("peaches", 3),
  ("apples", 5),
).to-dict()
Preview
self.to-dict()->
dictionary

reduce

Reduces the elements to a single one, by repeatedly applying a reducing operation.

If the array is empty, returns none, otherwise, returns the result of the reduction.

The reducing function is a closure with two arguments: an "accumulator", and an element.

For arrays with at least one element, this is the same as array.fold with the first element of the array as the initial accumulator value, folding every subsequent element into it.

self.reduce(
function
)->
any

reducer
function
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The reducing function. Must have two parameters: One for the accumulated value and one for an item.

Open official docs
Previous page

Arguments

Next page

Assert

Search