{"route":"/en-US-v0.14.1/reference/visualize/polygon/","title":"Polygon","description":"Documentation for the `polygon` 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-vertices","name":"vertices","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-regular","name":"Regular Polygon","children":[{"id":"definitions-regular-fill","name":"fill","children":[]},{"id":"definitions-regular-stroke","name":"stroke","children":[]},{"id":"definitions-regular-size","name":"size","children":[]},{"id":"definitions-regular-vertices","name":"vertices","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"polygon","title":"Polygon","keywords":[],"oneliner":"A closed polygon.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A closed polygon.

\n

The polygon is defined by its corner points and is closed automatically.

\n

Example

\n
#polygon(\n  fill: blue.lighten(80%),\n  stroke: blue,\n  (20%, 0pt),\n  (60%, 0pt),\n  (80%, 2cm),\n  (0%,  2cm),\n)\n
\"Preview\"
"}],"self":false,"params":[{"name":"fill","details":[{"kind":"html","content":"

How to fill the polygon.

\n

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

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

The drawing rule used to fill the polygon.

\n

See the curve documentation for an example.

"}],"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":[{"kind":"html","content":"

How to stroke the polygon.

\n

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

"}],"types":["none","auto","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"vertices","details":[{"kind":"html","content":"

The vertices of the polygon. Each point is specified as an array of two\nrelative lengths.

"}],"types":["array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[{"path":["polygon"],"name":"regular","title":"Regular Polygon","keywords":[],"oneliner":"A regular polygon, defined by its size and number of vertices.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A regular polygon, defined by its size and number of vertices.

"},{"kind":"example","content":{"body":"
#polygon.regular(\n  fill: blue.lighten(80%),\n  stroke: blue,\n  size: 30pt,\n  vertices: 3,\n)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"fill","details":[{"kind":"html","content":"

How to fill the polygon. See the general\npolygon's documentation for more details.

"}],"types":["none","color","gradient","tiling"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"stroke","details":[{"kind":"html","content":"

How to stroke the polygon. See the general\npolygon's documentation for more details.

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

The diameter of the circumcircle\nof the regular polygon.

"}],"types":["length"],"strings":[],"default":"1em","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"vertices","details":[{"kind":"html","content":"

The number of vertices in the polygon.

"}],"types":["int"],"strings":[],"default":"3","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}]}}}