https://cetz-package.github.io/docs/assets/js/eec33d54.a4dfd933.js

1"use strict";(self.webpackChunkcetz_documentation=self.webpackChunkcetz_documentation||[]).push([[4985],{987:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>d});var a=n(4848),o=n(8453);const r={},s="Path Decorations",i={id:"api/libraries/decorations/path/index",title:"Path Decorations",description:"Path decorations are elements that accept a path as input and generate one or more shapes that follow that path.",source:"@site/cetz/docs/api/libraries/decorations/path/index.mdx",sourceDirName:"api/libraries/decorations/path",slug:"/api/libraries/decorations/path/",permalink:"/docs/api/libraries/decorations/path/",draft:!1,unlisted:!1,editUrl:"https://github.com/cetz-package/docs/blob/main/cetz/docs/api/libraries/decorations/path/index.mdx",tags:[],version:"current",frontMatter:{},sidebar:"api",previous:{title:"Flat Brace",permalink:"/docs/api/libraries/decorations/braces/flat-brace"},next:{title:"Zigzag",permalink:"/docs/api/libraries/decorations/path/zigzag"}},c={},d=[];function l(e){const t={code:"code",em:"em",h1:"h1",header:"header",p:"p",...(0,o.R)(),...e.components},{Parameter:n,Type:r}=t;return n||p("Parameter",!0),r||p("Type",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"path-decorations",children:"Path Decorations"})}),"\n",(0,a.jsx)(t.p,{children:"Path decorations are elements that accept a path as input and generate one or more shapes that follow that path."}),"\n",(0,a.jsx)(t.p,{children:"All path decoration functions support the following style keys:"}),"\n",(0,a.jsx)(n,{name:"start",types:"ratio,length",default_value:"0%",children:(0,a.jsx)(t.p,{children:"Absolute or relative start of the decoration on the path."})}),"\n",(0,a.jsx)(n,{name:"end",types:"ratio,length",default_value:"100%",children:(0,a.jsx)(t.p,{children:"Absolute or relative end of the decoration on the path."})}),"\n",(0,a.jsx)(n,{name:"rest",types:"str",default_value:"LINE",children:(0,a.jsxs)(t.p,{children:["If set to ",(0,a.jsx)(t.code,{children:'"LINE"'}),", generate lines between the path's start/end and the\ndecoration's start/end if the path is ",(0,a.jsx)(t.em,{children:"not closed"}),"."]})}),"\n",(0,a.jsx)(n,{name:"width",types:"number",default_value:"1",children:(0,a.jsx)(t.p,{children:"Width or thickness of the decoration."})}),"\n",(0,a.jsx)(n,{name:"segments",types:"int",default_value:"10",children:(0,a.jsxs)(t.p,{children:["The number of repetitions/phases to generate. This key is ignored if\n",(0,a.jsx)(t.code,{children:"segment-length"})," is not ",(0,a.jsx)(r,{children:"none"})]})}),"\n",(0,a.jsx)(n,{name:"segment-length",types:"none,number",default_value:"none",children:(0,a.jsx)(t.p,{children:"Length of one repetion/phase of the decoration."})}),"\n",(0,a.jsx)(n,{name:"align",types:"str",default_value:"'START'",children:(0,a.jsxs)(t.p,{children:["Alignment of the decoration on the path ",(0,a.jsxs)(t.em,{children:["if ",(0,a.jsx)(t.code,{children:"segment-length"})," is set"]})," and the\ndecoration does not fill up the full range between start and stop. Can be one\nof ",(0,a.jsx)(t.code,{children:'"START"'}),", ",(0,a.jsx)(t.code,{children:'"MID"'}),", ",(0,a.jsx)(t.code,{children:'"END'}),"."]})})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}function p(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>i});var a=n(6540);const o={},r=a.createContext(o);function s(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]);