{"route":"/en-US-v0.13.1/reference/foundations/selector/","title":"Selector","description":"Documentation for the Selector type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-target","name":"target","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-or","name":"Or","children":[{"id":"definitions-or-others","name":"others","children":[]}]},{"id":"definitions-and","name":"And","children":[{"id":"definitions-and-others","name":"others","children":[]}]},{"id":"definitions-before","name":"Before","children":[{"id":"definitions-before-end","name":"end","children":[]},{"id":"definitions-before-inclusive","name":"inclusive","children":[]}]},{"id":"definitions-after","name":"After","children":[{"id":"definitions-after-start","name":"start","children":[]},{"id":"definitions-after-inclusive","name":"inclusive","children":[]}]}]}],"body":{"kind":"type","content":{"name":"selector","title":"Selector","keywords":[],"oneliner":"A filter for selecting elements within the document.","details":"

A filter for selecting elements within the document.

\n

You can construct a selector in the following ways:

\n\n

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

\n

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

\n

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

\n

Example

\n
#context query(\n  heading.where(level: 1)\n    .or(heading.where(level: 2))\n)\n\n= This will be found\n== So will this\n=== But this will not.\n
\"Preview\"
","constructor":{"path":[],"name":"selector","title":"Construct","keywords":[],"oneliner":"Turns a value into a selector. The following values are accepted:","element":false,"contextual":false,"deprecation":null,"details":"

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

\n","example":null,"self":false,"params":[{"name":"target","details":"

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

","example":null,"types":["str","regex","label","selector","location","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["selector"],"scope":[]},"scope":[{"path":["selector"],"name":"or","title":"Or","keywords":[],"oneliner":"Selects all elements that match this or any of the other selectors.","element":false,"contextual":false,"deprecation":null,"details":"

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

","example":null,"self":true,"params":[{"name":"others","details":"

The other selectors to match on.

","example":null,"types":["str","regex","label","selector","location","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["selector"],"scope":[]},{"path":["selector"],"name":"and","title":"And","keywords":[],"oneliner":"Selects all elements that match this and all of the other selectors.","element":false,"contextual":false,"deprecation":null,"details":"

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

","example":null,"self":true,"params":[{"name":"others","details":"

The other selectors to match on.

","example":null,"types":["str","regex","label","selector","location","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["selector"],"scope":[]},{"path":["selector"],"name":"before","title":"Before","keywords":[],"oneliner":"Returns a modified selector that will only match elements that occur","element":false,"contextual":false,"deprecation":null,"details":"

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

","example":null,"self":true,"params":[{"name":"end","details":"

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

","example":null,"types":["label","selector","location","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"inclusive","details":"

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

","example":null,"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["selector"],"scope":[]},{"path":["selector"],"name":"after","title":"After","keywords":[],"oneliner":"Returns a modified selector that will only match elements that occur","element":false,"contextual":false,"deprecation":null,"details":"

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

","example":null,"self":true,"params":[{"name":"start","details":"

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

","example":null,"types":["label","selector","location","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"inclusive","details":"

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

","example":null,"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["selector"],"scope":[]}]}}}