• 
• 
• 参考
• 
• 基础
• 
• Selector

selector

A filter for selecting elements within the document.

You can construct a selector in the following ways:

• you can use an element function
• you can filter for an element function with specific fields
• you can use a string or regular expression
• you can use a <label>
• you can use a location
• call the selector constructor to convert any of the above types into a selector value and use the methods below to refine it

Selectors are used to apply styling rules to elements. You can also use selectors to query the document for certain types of elements.

Furthermore, you can pass a selector to several of Typst's built-in functions to configure their behaviour. One such example is the outline where it can be used to change which elements are listed within the outline.

Multiple selectors can be combined using the methods shown below. However, not all kinds of selectors are supported in all places, at the moment.

Example

#locate(loc => query(
  heading.where(level: 1)
    .or(heading.where(level: 2)),
  loc,
))

= This will be found
== So will this
=== But this will not.

构造函数

如果类型具有构造函数，可以像函数一样调用它来创建一个该类型的值。

Turns a value into a selector. The following values are accepted:

• An element function like a heading or figure.
• A <label>.
• A more complex selector like heading.where(level: 1).

target

str regex label selector location function

必需参数位置参数

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

Can be an element function like a heading or figure, a <label> or a more complex selector like heading.where(level: 1).

定义

函数和类型可以有与其关联的定义 (成员或方法)。可以使用 "." 操作符来访问调用它们。

or

Selects all elements that match this or any of the other selectors.

others

label selector function

必需参数位置参数

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

可变参数

可变参数可以多次传入。

The other selectors to match on.

and

Selects all elements that match this and all of the the other selectors.

others

label selector function

必需参数位置参数

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

可变参数

可变参数可以多次传入。

The other selectors to match on.

before

Returns a modified selector that will only match elements that occur before the first match of end.

end

label selector function

必需参数位置参数

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

The original selection will end at the first match of end.

inclusive

bool

Whether end itself should match or not. This is only relevant if both selectors match the same type of element. Defaults to true.

默认：true

after

Returns a modified selector that will only match elements that occur after the first match of start.

start

label selector function

必需参数位置参数

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

The original selection will start at the first match of start.

inclusive

bool

Whether start itself should match or not. This is only relevant if both selectors match the same type of element. Defaults to true.

默认：true

Representation上一页

String下一页