{"route":"/en-US-v0.14.1/reference/visualize/circle/","title":"Circle","description":"Documentation for the `circle` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-radius","name":"radius","children":[]},{"id":"parameters-width","name":"width","children":[]},{"id":"parameters-height","name":"height","children":[]},{"id":"parameters-fill","name":"fill","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-inset","name":"inset","children":[]},{"id":"parameters-outset","name":"outset","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"circle","title":"Circle","keywords":[],"oneliner":"A circle with optional content.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"<p>A circle with optional content.</p>\n<h2 id=\"example\">Example</h2>\n<div class=\"previewed-code\"><pre><code><span class=\"typ-comment\">// Without content.</span>\n<span class=\"typ-func\">#</span><span class=\"typ-func\">circle</span><span class=\"typ-punct\">(</span>radius<span class=\"typ-punct\">:</span> <span class=\"typ-num\">25pt</span><span class=\"typ-punct\">)</span>\n\n<span class=\"typ-comment\">// With content.</span>\n<span class=\"typ-func\">#</span><span class=\"typ-func\">circle</span><span class=\"typ-punct\">[</span>\n  <span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> <span class=\"typ-func\">align</span><span class=\"typ-punct\">(</span>center <span class=\"typ-op\">+</span> horizon<span class=\"typ-punct\">)</span>\n  Automatically <span class=\"typ-escape\">\\</span>\n  sized to fit.\n<span class=\"typ-punct\">]</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.14.1/assets/1f59e2c057a82944d5833baa72667f56.png\" alt=\"Preview\"></div></div>"}],"self":false,"params":[{"name":"radius","details":[{"kind":"html","content":"<p>The circle's radius. This is mutually exclusive with <code>width</code> and\n<code>height</code>.</p>"}],"types":["length"],"strings":[],"default":"<code><span class=\"typ-num\">0pt</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"width","details":[{"kind":"html","content":"<p>The circle's width. This is mutually exclusive with <code>radius</code> and\n<code>height</code>.</p>\n<p>In contrast to <code>radius</code>, this can be relative to the parent container's\nwidth.</p>"}],"types":["auto","relative"],"strings":[],"default":"<code><span class=\"typ-key\">auto</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"height","details":[{"kind":"html","content":"<p>The circle's height. This is mutually exclusive with <code>radius</code> and\n<code>width</code>.</p>\n<p>In contrast to <code>radius</code>, this can be relative to the parent container's\nheight.</p>"}],"types":["auto","relative","fraction"],"strings":[],"default":"<code><span class=\"typ-key\">auto</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill","details":[{"kind":"html","content":"<p>How to fill the circle. See the <a href=\"/en-US-v0.14.1/reference/visualize/rect/#parameters-fill\">rectangle's documentation</a>\nfor more details.</p>"}],"types":["none","color","gradient","tiling"],"strings":[],"default":"<code><span class=\"typ-key\">none</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":[{"kind":"html","content":"<p>How to stroke the circle. See the\n<a href=\"/en-US-v0.14.1/reference/visualize/rect/#parameters-stroke\">rectangle's documentation</a> for more details.</p>"}],"types":["none","auto","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"<code><span class=\"typ-key\">auto</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"inset","details":[{"kind":"html","content":"<p>How much to pad the circle's content. See the\n<a href=\"/en-US-v0.14.1/reference/layout/box/#parameters-inset\">box's documentation</a> for more details.</p>"}],"types":["relative","dictionary"],"strings":[],"default":"<code><span class=\"typ-num\">0%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">5pt</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"outset","details":[{"kind":"html","content":"<p>How much to expand the circle's size without affecting the layout. See\nthe <a href=\"/en-US-v0.14.1/reference/layout/box/#parameters-outset\">box's documentation</a> for more details.</p>"}],"types":["relative","dictionary"],"strings":[],"default":"<code><span class=\"typ-punct\">(</span><span class=\"typ-punct\">:</span><span class=\"typ-punct\">)</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":[{"kind":"html","content":"<p>The content to place into the circle. The circle expands to fit this\ncontent, keeping the 1-1 aspect ratio.</p>"}],"types":["none","content"],"strings":[],"default":"<code><span class=\"typ-key\">none</span></code>","positional":true,"named":false,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}}}