{"route":"/en-US-v0.14.1/reference/visualize/line/","title":"Line","description":"Documentation for the `line` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-start","name":"start","children":[]},{"id":"parameters-end","name":"end","children":[]},{"id":"parameters-length","name":"length","children":[]},{"id":"parameters-angle","name":"angle","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"line","title":"Line","keywords":[],"oneliner":"A line from one point to another.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"<p>A line from one point to another.</p>\n<h2 id=\"example\">Example</h2>\n<div class=\"previewed-code\"><pre><code><span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> <span class=\"typ-func\">page</span><span class=\"typ-punct\">(</span>height<span class=\"typ-punct\">:</span> <span class=\"typ-num\">100pt</span><span class=\"typ-punct\">)</span>\n\n<span class=\"typ-func\">#</span><span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>length<span class=\"typ-punct\">:</span> <span class=\"typ-num\">100%</span><span class=\"typ-punct\">)</span>\n<span class=\"typ-func\">#</span><span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>end<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">(</span><span class=\"typ-num\">50%</span><span class=\"typ-punct\">,</span> <span class=\"typ-num\">50%</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span>\n<span class=\"typ-func\">#</span><span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>\n  length<span class=\"typ-punct\">:</span> <span class=\"typ-num\">4cm</span><span class=\"typ-punct\">,</span>\n  stroke<span class=\"typ-punct\">:</span> <span class=\"typ-num\">2pt</span> <span class=\"typ-op\">+</span> maroon<span class=\"typ-punct\">,</span>\n<span class=\"typ-punct\">)</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.14.1/assets/20174b08a5b487d90d5ace96ffc0ca03.png\" alt=\"Preview\"></div></div>"}],"self":false,"params":[{"name":"start","details":[{"kind":"html","content":"<p>The start point of the line.</p>\n<p>Must be an array of exactly two relative lengths.</p>"}],"types":["array"],"strings":[],"default":"<code><span class=\"typ-punct\">(</span><span class=\"typ-num\">0%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">0pt</span><span class=\"typ-punct\">,</span> <span class=\"typ-num\">0%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">0pt</span><span class=\"typ-punct\">)</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"end","details":[{"kind":"html","content":"<p>The point where the line ends.</p>"}],"types":["none","array"],"strings":[],"default":"<code><span class=\"typ-key\">none</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"length","details":[{"kind":"html","content":"<p>The line's length. This is only respected if <code>end</code> is <code><span class=\"typ-key\">none</span></code>.</p>"}],"types":["relative"],"strings":[],"default":"<code><span class=\"typ-num\">0%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">30pt</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"angle","details":[{"kind":"html","content":"<p>The angle at which the line points away from the origin. This is only\nrespected if <code>end</code> is <code><span class=\"typ-key\">none</span></code>.</p>"}],"types":["angle"],"strings":[],"default":"<code><span class=\"typ-num\">0deg</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":[{"kind":"html","content":"<p>How to <a href=\"/en-US-v0.14.1/reference/visualize/stroke/\" title=\"stroke\">stroke</a> the line.</p>"},{"kind":"example","content":{"body":"<div class=\"previewed-code\"><pre><code><span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> <span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>length<span class=\"typ-punct\">:</span> <span class=\"typ-num\">100%</span><span class=\"typ-punct\">)</span>\n<span class=\"typ-func\">#</span><span class=\"typ-func\">stack</span><span class=\"typ-punct\">(</span>\n  spacing<span class=\"typ-punct\">:</span> <span class=\"typ-num\">1em</span><span class=\"typ-punct\">,</span>\n  <span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>stroke<span class=\"typ-punct\">:</span> <span class=\"typ-num\">2pt</span> <span class=\"typ-op\">+</span> red<span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span>\n  <span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>stroke<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">(</span>paint<span class=\"typ-punct\">:</span> blue<span class=\"typ-punct\">,</span> thickness<span class=\"typ-punct\">:</span> <span class=\"typ-num\">4pt</span><span class=\"typ-punct\">,</span> cap<span class=\"typ-punct\">:</span> <span class=\"typ-str\">&quot;round&quot;</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span>\n  <span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>stroke<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">(</span>paint<span class=\"typ-punct\">:</span> blue<span class=\"typ-punct\">,</span> thickness<span class=\"typ-punct\">:</span> <span class=\"typ-num\">1pt</span><span class=\"typ-punct\">,</span> dash<span class=\"typ-punct\">:</span> <span class=\"typ-str\">&quot;dashed&quot;</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span>\n  <span class=\"typ-func\">line</span><span class=\"typ-punct\">(</span>stroke<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">(</span>paint<span class=\"typ-punct\">:</span> blue<span class=\"typ-punct\">,</span> thickness<span class=\"typ-punct\">:</span> <span class=\"typ-num\">1pt</span><span class=\"typ-punct\">,</span> dash<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">(</span><span class=\"typ-str\">&quot;dot&quot;</span><span class=\"typ-punct\">,</span> <span class=\"typ-num\">2pt</span><span class=\"typ-punct\">,</span> <span class=\"typ-num\">4pt</span><span class=\"typ-punct\">,</span> <span class=\"typ-num\">2pt</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span>\n<span class=\"typ-punct\">)</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.14.1/assets/4a1c2aa65f57ad6920e80d57cc1a24e8.png\" alt=\"Preview\"></div></div>","title":null}}],"types":["length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"<code><span class=\"typ-num\">1pt</span> <span class=\"typ-op\">+</span> black</code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}}}