{"route":"/en-US-v0.13.1/reference/visualize/path/","title":"Path","description":"Documentation for the `path` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-fill","name":"fill","children":[]},{"id":"parameters-fill-rule","name":"fill-rule","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-closed","name":"closed","children":[]},{"id":"parameters-vertices","name":"vertices","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"path","title":"Path","keywords":[],"oneliner":"A path through a list of points, connected by Bézier curves.","element":true,"contextual":false,"deprecation":"the `path` function is deprecated, use `curve` instead","details":"

A path through a list of points, connected by Bézier curves.

\n

Example

\n
#path(\n  fill: blue.lighten(80%),\n  stroke: blue,\n  closed: true,\n  (0pt, 50pt),\n  (100%, 50pt),\n  ((50%, 0pt), (40pt, 0pt)),\n)\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"fill","details":"

How to fill the path.

\n

When setting a fill, the default stroke disappears. To create a\nrectangle with both fill and stroke, you have to configure both.

","example":null,"types":["none","color","gradient","tiling"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill-rule","details":"

The drawing rule used to fill the path.

","example":"
// We use `.with` to get a new\n// function that has the common\n// arguments pre-applied.\n#let star = path.with(\n  fill: red,\n  closed: true,\n  (25pt, 0pt),\n  (10pt, 50pt),\n  (50pt, 20pt),\n  (0pt, 20pt),\n  (40pt, 50pt),\n)\n\n#star(fill-rule: "non-zero")\n#star(fill-rule: "even-odd")\n
\"Preview\"
","types":["str"],"strings":[{"string":"non-zero","details":"

Specifies that "inside" is computed by a non-zero sum of signed edge crossings.

"},{"string":"even-odd","details":"

Specifies that "inside" is computed by an odd number of edge crossings.

"}],"default":""non-zero"","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

How to stroke the path. This can be:

\n

Can be set to none to disable the stroke or to auto for a\nstroke of 1pt black if and if only if no fill is given.

","example":null,"types":["none","auto","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"closed","details":"

Whether to close this path with one last Bézier curve. This curve will\ntake into account the adjacent control points. If you want to close\nwith a straight line, simply add one last point that's the same as the\nstart point.

","example":null,"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"vertices","details":"

The vertices of the path.

\n

Each vertex can be defined in 3 ways:

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