{"route":"/en-US-v0.14.1/reference/text/overline/","title":"Overline","description":"Documentation for the `overline` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-offset","name":"offset","children":[]},{"id":"parameters-extent","name":"extent","children":[]},{"id":"parameters-evade","name":"evade","children":[]},{"id":"parameters-background","name":"background","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"overline","title":"Overline","keywords":[],"oneliner":"Adds a line over text.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Adds a line over text.

\n

Example

\n
#overline[A line over text.]\n
\"Preview\"
"}],"self":false,"params":[{"name":"stroke","details":[{"kind":"html","content":"

How to stroke the line.

\n

If set to auto, takes on the text's color and a thickness defined in\nthe current font.

"},{"kind":"example","content":{"body":"
#set text(fill: olive)\n#overline(\n  stroke: green.darken(20%),\n  offset: -12pt,\n  [The Forest Theme],\n)\n
\"Preview\"
","title":null}}],"types":["auto","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"offset","details":[{"kind":"html","content":"

The position of the line relative to the baseline. Read from the font\ntables if auto.

"},{"kind":"example","content":{"body":"
#overline(offset: -1.2em)[\n  The Tale Of A Faraway Line II\n]\n
\"Preview\"
","title":null}}],"types":["auto","length"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"extent","details":[{"kind":"html","content":"

The amount by which to extend the line beyond (or within if negative)\nthe content.

"},{"kind":"example","content":{"body":"
#set overline(extent: 4pt)\n#set underline(extent: 4pt)\n#overline(underline[Typography Today])\n
\"Preview\"
","title":null}}],"types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"evade","details":[{"kind":"html","content":"

Whether the line skips sections in which it would collide with the\nglyphs.

"},{"kind":"example","content":{"body":"
#overline(\n  evade: false,\n  offset: -7.5pt,\n  stroke: 1pt,\n  extent: 3pt,\n  [Temple],\n)\n
\"Preview\"
","title":null}}],"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"background","details":[{"kind":"html","content":"

Whether the line is placed behind the content it overlines.

"},{"kind":"example","content":{"body":"
#set overline(stroke: (thickness: 1em, paint: maroon, cap: "round"))\n#overline(background: true)[This is stylized.] \\\n#overline(background: false)[This is partially hidden.]\n
\"Preview\"
","title":null}}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":[{"kind":"html","content":"

The content to add a line over.

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