{"route":"/en-US-v0.13.1/reference/layout/place/","title":"Place","description":"Documentation for the `place` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"examples","name":"Examples","children":[]},{"id":"effect-on-other-elements","name":"Effect On Other Elements","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-alignment","name":"alignment","children":[]},{"id":"parameters-scope","name":"scope","children":[]},{"id":"parameters-float","name":"float","children":[]},{"id":"parameters-clearance","name":"clearance","children":[]},{"id":"parameters-dx","name":"dx","children":[]},{"id":"parameters-dy","name":"dy","children":[]},{"id":"parameters-body","name":"body","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-flush","name":"Flush","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"place","title":"Place","keywords":[],"oneliner":"Places content relatively to its parent container.","element":true,"contextual":false,"deprecation":null,"details":"

Places content relatively to its parent container.

\n

Placed content can be either overlaid (the default) or floating. Overlaid\ncontent is aligned with the parent container according to the given\nalignment, and shown over any other content added so\nfar in the container. Floating content is placed at the top or bottom of\nthe container, displacing other content down or up respectively. In both\ncases, the content position can be adjusted with dx and\ndy offsets without affecting the layout.

\n

The parent can be any container such as a block, box,\nrect, etc. A top level place call will place content directly\nin the text area of the current page. This can be used for absolute\npositioning on the page: with a top + left\nalignment, the offsets dx and dy will set the\nposition of the element's top left corner relatively to the top left corner\nof the text area. For absolute positioning on the full page including\nmargins, you can use place in page.foreground or\npage.background.

\n

Examples

\n
#set page(height: 120pt)\nHello, world!\n\n#rect(\n  width: 100%,\n  height: 2cm,\n  place(horizon + right, square()),\n)\n\n#place(\n  top + left,\n  dx: -5pt,\n  square(size: 5pt, fill: red),\n)\n
\"Preview\"
\n

Effect on the position of other elements

\n

Overlaid elements don't take space in the flow of content, but a place\ncall inserts an invisible block-level element in the flow. This can\naffect the layout by breaking the current paragraph. To avoid this,\nyou can wrap the place call in a box when the call is made\nin the middle of a paragraph. The alignment and offsets will then be\nrelative to this zero-size box. To make sure it doesn't interfere with\nspacing, the box should be attached to a word using a word joiner.

\n

For example, the following defines a function for attaching an annotation\nto the following word:

\n
#let annotate(..args) = {\n  box(place(..args))\n  sym.wj\n  h(0pt, weak: true)\n}\n\nA placed #annotate(square(), dy: 2pt)\nsquare in my text.\n
\"Preview\"
\n

The zero-width weak spacing serves to discard spaces between the function\ncall and the next word.

","example":null,"self":false,"params":[{"name":"alignment","details":"

Relative to which position in the parent container to place the content.

\n\n

When float is false and no vertical alignment is specified, the\ncontent is placed at the current position on the vertical axis.

","example":null,"types":["auto","alignment"],"strings":[],"default":"start","positional":true,"named":false,"required":false,"variadic":false,"settable":true},{"name":"scope","details":"

Relative to which containing scope something is placed.

\n

The parent scope is primarily used with figures and, for\nthis reason, the figure function has a mirrored scope\nparameter. Nonetheless, it can also be more generally\nuseful to break out of the columns. A typical example would be to\ncreate a single-column title section\nin a two-column document.

\n

Note that parent-scoped placement is currently only supported if float\nis true. This may change in the future.

","example":"
#set page(height: 150pt, columns: 2)\n#place(\n  top + center,\n  scope: "parent",\n  float: true,\n  rect(width: 80%, fill: aqua),\n)\n\n#lorem(25)\n
\"Preview\"
","types":["str"],"strings":[{"string":"column","details":"

Place into the current column.

"},{"string":"parent","details":"

Place relative to the parent, letting the content span over all columns.

"}],"default":""column"","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"float","details":"

Whether the placed element has floating layout.

\n

Floating elements are positioned at the top or bottom of the parent\ncontainer, displacing in-flow content. They are always placed in the\nin-flow order relative to each other, as well as before any content\nfollowing a later place.flush element.

","example":"
#set page(height: 150pt)\n#let note(where, body) = place(\n  center + where,\n  float: true,\n  clearance: 6pt,\n  rect(body),\n)\n\n#lorem(10)\n#note(bottom)[Bottom 1]\n#note(bottom)[Bottom 2]\n#lorem(40)\n#note(top)[Top]\n#lorem(10)\n
\"Preview\"
","types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"clearance","details":"

The spacing between the placed element and other elements in a floating\nlayout.

\n

Has no effect if float is false.

","example":null,"types":["length"],"strings":[],"default":"1.5em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"dx","details":"

The horizontal displacement of the placed content.

","example":"
#set page(height: 100pt)\n#for i in range(16) {\n  let amount = i * 4pt\n  place(center, dx: amount - 32pt, dy: amount)[A]\n}\n
\"Preview\"
\n

This does not affect the layout of in-flow content.\nIn other words, the placed content is treated as if it\nwere wrapped in a move element.

","types":["relative"],"strings":[],"default":"0% + 0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"dy","details":"

The vertical displacement of the placed content.

\n

This does not affect the layout of in-flow content.\nIn other words, the placed content is treated as if it\nwere wrapped in a move element.

","example":null,"types":["relative"],"strings":[],"default":"0% + 0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The content to place.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[{"path":["place"],"name":"flush","title":"Flush","keywords":[],"oneliner":"Asks the layout algorithm to place pending floating elements before","element":true,"contextual":false,"deprecation":null,"details":"

Asks the layout algorithm to place pending floating elements before\ncontinuing with the content.

\n

This is useful for preventing floating figures from spilling\ninto the next section.

","example":"
#lorem(15)\n\n#figure(\n  rect(width: 100%, height: 50pt),\n  placement: auto,\n  caption: [A rectangle],\n)\n\n#place.flush()\n\nThis text appears after the figure.\n
\"Preview\"
","self":false,"params":[],"returns":["content"],"scope":[]}]}}}