{"route":"/en-US-v0.14.1/reference/layout/ratio/","title":"Ratio","description":"Documentation for the Ratio type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"scripting","name":"Scripting","children":[]}],"body":{"kind":"type","content":{"name":"ratio","title":"Ratio","keywords":[],"oneliner":"A ratio of a whole.","details":"<p>A ratio of a whole.</p>\n<p>A ratio is written as a number, followed by a percent sign. Ratios most\noften appear as part of a <a href=\"/en-US-v0.14.1/reference/layout/relative/\">relative length</a>, to specify the size\nof some layout element relative to the page or some container.</p>\n<div class=\"previewed-code\"><pre><code><span class=\"typ-func\">#</span><span class=\"typ-func\">rect</span><span class=\"typ-punct\">(</span>width<span class=\"typ-punct\">:</span> <span class=\"typ-num\">25%</span><span class=\"typ-punct\">)</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.14.1/assets/4d00e48a14d2fa6bbfde5bd85623a199.png\" alt=\"Preview\"></div></div>\n<p>However, they can also describe any other property that is relative to some\nbase, e.g. an amount of <a href=\"/en-US-v0.14.1/reference/layout/scale/#parameters-x\">horizontal scaling</a> or the\n<a href=\"/en-US-v0.14.1/reference/math/lr/#functions-lr-size\">height of parentheses</a> relative to the height of the content\nthey enclose.</p>\n<h2 id=\"scripting\">Scripting</h2>\n<p>Within your own code, you can use ratios as you like. You can multiply them\nwith various other types as shown below:</p>\n<table><thead><tr><th>Multiply by</th><th>Example</th><th>Result</th></tr></thead><tbody>\n<tr><td><a href=\"/en-US-v0.14.1/reference/layout/ratio/\" title=\"`ratio`\"><code>ratio</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-num\">10%</span></code></td><td><code><span class=\"typ-num\">2.7%</span></code></td></tr>\n<tr><td><a href=\"/en-US-v0.14.1/reference/layout/length/\" title=\"`length`\"><code>length</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-num\">100pt</span></code></td><td><code><span class=\"typ-num\">27pt</span></code></td></tr>\n<tr><td><a href=\"/en-US-v0.14.1/reference/layout/relative/\" title=\"`relative`\"><code>relative</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-punct\">(</span><span class=\"typ-num\">10%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">100pt</span><span class=\"typ-punct\">)</span></code></td><td><code><span class=\"typ-num\">2.7%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">27pt</span></code></td></tr>\n<tr><td><a href=\"/en-US-v0.14.1/reference/layout/angle/\" title=\"`angle`\"><code>angle</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-num\">100deg</span></code></td><td><code><span class=\"typ-num\">27deg</span></code></td></tr>\n<tr><td><a href=\"/en-US-v0.14.1/reference/foundations/int/\" title=\"`int`\"><code>int</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-num\">2</span></code></td><td><code><span class=\"typ-num\">54%</span></code></td></tr>\n<tr><td><a href=\"/en-US-v0.14.1/reference/foundations/float/\" title=\"`float`\"><code>float</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-num\">0.37037</span></code></td><td><code><span class=\"typ-num\">10%</span></code></td></tr>\n<tr><td><a href=\"/en-US-v0.14.1/reference/layout/fraction/\" title=\"`fraction`\"><code>fraction</code></a></td><td><code><span class=\"typ-num\">27%</span> <span class=\"typ-op\">*</span> <span class=\"typ-num\">3fr</span></code></td><td><code><span class=\"typ-num\">0.81fr</span></code></td></tr>\n</tbody></table>\n<p>When ratios are <a href=\"/en-US-v0.14.1/reference/foundations/repr/\">displayed</a> in the document, they are rounded to two\nsignificant digits for readability.</p>","constructor":null,"scope":[]}}}