{"route":"/en-US-v0.14.1/reference/math/attach/","title":"Attach","description":"Documentation for the attach functions.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"functions","name":"Functions","children":[{"id":"functions-attach","name":"Attach","children":[{"id":"functions-attach-base","name":"base","children":[]},{"id":"functions-attach-t","name":"t","children":[]},{"id":"functions-attach-b","name":"b","children":[]},{"id":"functions-attach-tl","name":"tl","children":[]},{"id":"functions-attach-bl","name":"bl","children":[]},{"id":"functions-attach-tr","name":"tr","children":[]},{"id":"functions-attach-br","name":"br","children":[]}]},{"id":"functions-scripts","name":"Scripts","children":[{"id":"functions-scripts-body","name":"body","children":[]}]},{"id":"functions-limits","name":"Limits","children":[{"id":"functions-limits-body","name":"body","children":[]},{"id":"functions-limits-inline","name":"inline","children":[]}]}]}],"body":{"kind":"group","content":{"name":"attach","title":"Attach","details":"

Subscript, superscripts, and limits.

\n

Attachments can be displayed either as sub/superscripts, or limits. Typst\nautomatically decides which is more suitable depending on the base, but you\ncan also control this manually with the scripts and limits functions.

\n

If you want the base to stretch to fit long top and bottom attachments (for\nexample, an arrow with text above it), use the stretch\nfunction.

\n

Example

\n
$ sum_(i=0)^n a_i = 2^(1+i) $\n
\"Preview\"
\n

Syntax

\n

This function also has dedicated syntax for attachments after the base: Use\nthe underscore (_) to indicate a subscript i.e. bottom attachment and the\nhat (^) to indicate a superscript i.e. top attachment.

","functions":[{"path":["math"],"name":"attach","title":"Attach","keywords":[],"oneliner":"A base with optional attachments.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A base with optional attachments.

"},{"kind":"example","content":{"body":"
$ attach(\n  Pi, t: alpha, b: beta,\n  tl: 1, tr: 2+3, bl: 4+5, br: 6,\n) $\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"base","details":[{"kind":"html","content":"

The base to which things are attached.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"t","details":[{"kind":"html","content":"

The top attachment, smartly positioned at top-right or above the base.

\n

You can wrap the base in limits() or scripts() to override the\nsmart positioning.

"}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"b","details":[{"kind":"html","content":"

The bottom attachment, smartly positioned at the bottom-right or below\nthe base.

\n

You can wrap the base in limits() or scripts() to override the\nsmart positioning.

"}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"tl","details":[{"kind":"html","content":"

The top-left attachment (before the base).

"}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"bl","details":[{"kind":"html","content":"

The bottom-left attachment (before base).

"}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"tr","details":[{"kind":"html","content":"

The top-right attachment (after the base).

"}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"br","details":[{"kind":"html","content":"

The bottom-right attachment (after the base).

"}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]},{"path":["math"],"name":"scripts","title":"Scripts","keywords":[],"oneliner":"Forces a base to display attachments as scripts.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Forces a base to display attachments as scripts.

"},{"kind":"example","content":{"body":"
$ scripts(sum)_1^2 != sum_1^2 $\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"body","details":[{"kind":"html","content":"

The base to attach the scripts to.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]},{"path":["math"],"name":"limits","title":"Limits","keywords":[],"oneliner":"Forces a base to display attachments as limits.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Forces a base to display attachments as limits.

"},{"kind":"example","content":{"body":"
$ limits(A)_1^2 != A_1^2 $\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"body","details":[{"kind":"html","content":"

The base to attach the limits to.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"inline","details":[{"kind":"html","content":"

Whether to also force limits in inline equations.

\n

When applying limits globally (e.g., through a show rule), it is\ntypically a good idea to disable this.

"}],"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}],"global_attributes":[]}}}