{"route":"/en-US-v0.13.1/reference/math/cancel/","title":"Cancel","description":"Documentation for the `cancel` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-body","name":"body","children":[]},{"id":"parameters-length","name":"length","children":[]},{"id":"parameters-inverted","name":"inverted","children":[]},{"id":"parameters-cross","name":"cross","children":[]},{"id":"parameters-angle","name":"angle","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]}]}],"body":{"kind":"func","content":{"path":["math"],"name":"cancel","title":"Cancel","keywords":[],"oneliner":"Displays a diagonal line over a part of an equation.","element":true,"contextual":false,"deprecation":null,"details":"<p>Displays a diagonal line over a part of an equation.</p>\n<p>This is commonly used to show the elimination of a term.</p>\n<h2 id=\"example\">Example</h2>\n<div class=\"previewed-code\"><pre><code>Here, we can simplify:\n<span class=\"typ-math-delim\">$</span> <span class=\"typ-punct\">(</span>a <span class=\"typ-pol\">dot</span> b <span class=\"typ-pol\">dot</span> <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>x<span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span> <span class=\"typ-math-op\">/</span>\n    <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>x<span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/7d5119bd78ca4e4dacdd63bcf2ddcaf0.png\" alt=\"Preview\"></div></div>","example":null,"self":false,"params":[{"name":"body","details":"<p>The content over which the line should be placed.</p>","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"length","details":"<p>The length of the line, relative to the length of the diagonal spanning\nthe whole element being &quot;cancelled&quot;. A value of <code><span class=\"typ-num\">100%</span></code> would then have\nthe line span precisely the element's diagonal.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-math-delim\">$</span> a + <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>x<span class=\"typ-punct\">,</span> length<span class=\"typ-punct\">:</span> <span class=\"typ-num\">#</span><span class=\"typ-num\">200%</span><span class=\"typ-punct\">)</span>\n    <span class=\"typ-escape\">-</span> <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>x<span class=\"typ-punct\">,</span> length<span class=\"typ-punct\">:</span> <span class=\"typ-num\">#</span><span class=\"typ-num\">200%</span><span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/fd148a56b3439c5e7fa4027244c99cac.png\" alt=\"Preview\"></div></div>","types":["relative"],"strings":[],"default":"<code><span class=\"typ-num\">100%</span> <span class=\"typ-op\">+</span> <span class=\"typ-num\">3pt</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"inverted","details":"<p>Whether the cancel line should be inverted (flipped along the y-axis).\nFor the default angle setting, inverted means the cancel line\npoints to the top left instead of top right.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-math-delim\">$</span> <span class=\"typ-punct\">(</span>a <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>(b + c)<span class=\"typ-punct\">,</span> inverted<span class=\"typ-punct\">:</span> <span class=\"typ-key\">#</span><span class=\"typ-key\">true</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span> <span class=\"typ-math-op\">/</span>\n    <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>b + c<span class=\"typ-punct\">,</span> inverted<span class=\"typ-punct\">:</span> <span class=\"typ-key\">#</span><span class=\"typ-key\">true</span><span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/19696e45aa5e672f241d0899e5cdd76d.png\" alt=\"Preview\"></div></div>","types":["bool"],"strings":[],"default":"<code><span class=\"typ-key\">false</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"cross","details":"<p>Whether two opposing cancel lines should be drawn, forming a cross over\nthe element. Overrides <code>inverted</code>.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span><span class=\"typ-pol\">Pi</span><span class=\"typ-punct\">,</span> cross<span class=\"typ-punct\">:</span> <span class=\"typ-key\">#</span><span class=\"typ-key\">true</span><span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/6e2222d3d2e291c0e7c1a03459a37025.png\" alt=\"Preview\"></div></div>","types":["bool"],"strings":[],"default":"<code><span class=\"typ-key\">false</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"angle","details":"<p>How much to rotate the cancel line.</p>\n<ul>\n<li>If given an angle, the line is rotated by that angle clockwise with\nrespect to the y-axis.</li>\n<li>If <code><span class=\"typ-key\">auto</span></code>, the line assumes the default angle; that is, along the\nrising diagonal of the content box.</li>\n<li>If given a function <code>angle =&gt; angle</code>, the line is rotated, with\nrespect to the y-axis, by the angle returned by that function. The\nfunction receives the default angle as its input.</li>\n</ul>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span><span class=\"typ-pol\">Pi</span><span class=\"typ-punct\">)</span>\n  <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span><span class=\"typ-pol\">Pi</span><span class=\"typ-punct\">,</span> angle<span class=\"typ-punct\">:</span> <span class=\"typ-num\">#</span><span class=\"typ-num\">0deg</span><span class=\"typ-punct\">)</span>\n  <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span><span class=\"typ-pol\">Pi</span><span class=\"typ-punct\">,</span> angle<span class=\"typ-punct\">:</span> <span class=\"typ-num\">#</span><span class=\"typ-num\">45deg</span><span class=\"typ-punct\">)</span>\n  <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span><span class=\"typ-pol\">Pi</span><span class=\"typ-punct\">,</span> angle<span class=\"typ-punct\">:</span> <span class=\"typ-num\">#</span><span class=\"typ-num\">90deg</span><span class=\"typ-punct\">)</span>\n  <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>1<span class=\"typ-math-op\">/</span><span class=\"typ-punct\">(</span>1+x<span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span> angle<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">#</span><span class=\"typ-punct\">(</span>a <span class=\"typ-op\">=&gt;</span> a <span class=\"typ-op\">+</span> <span class=\"typ-num\">45deg</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span>\n  <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>1<span class=\"typ-math-op\">/</span><span class=\"typ-punct\">(</span>1+x<span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span> angle<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">#</span><span class=\"typ-punct\">(</span>a <span class=\"typ-op\">=&gt;</span> a <span class=\"typ-op\">+</span> <span class=\"typ-num\">90deg</span><span class=\"typ-punct\">)</span><span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/38212630bf4a4126384abbb4ce4dd71b.png\" alt=\"Preview\"></div></div>","types":["auto","angle","function"],"strings":[],"default":"<code><span class=\"typ-key\">auto</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"<p>How to <a href=\"/en-US-v0.13.1/reference/visualize/stroke/\">stroke</a> the cancel line.</p>","example":"<div class=\"previewed-code\"><pre><code><span class=\"typ-math-delim\">$</span> <span class=\"typ-func\">cancel</span><span class=\"typ-punct\">(</span>\n  <span class=\"typ-pol\">sum</span> x<span class=\"typ-punct\">,</span>\n  stroke<span class=\"typ-punct\">:</span> <span class=\"typ-punct\">#</span><span class=\"typ-punct\">(</span>\n    paint<span class=\"typ-punct\">:</span> red<span class=\"typ-punct\">,</span>\n    thickness<span class=\"typ-punct\">:</span> <span class=\"typ-num\">1.5pt</span><span class=\"typ-punct\">,</span>\n    dash<span class=\"typ-punct\">:</span> <span class=\"typ-str\">&quot;dashed&quot;</span><span class=\"typ-punct\">,</span>\n  <span class=\"typ-punct\">)</span><span class=\"typ-punct\">,</span>\n<span class=\"typ-punct\">)</span> <span class=\"typ-math-delim\">$</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.13.1/assets/28257b7a29918744372f166e763f080c.png\" alt=\"Preview\"></div></div>","types":["length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"<code><span class=\"typ-num\">0.5pt</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}}}