1"use strict";(self.webpackChunk_sigma_website=self.webpackChunk_sigma_website||[]).push([[5101],{4132:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>t,default:()=>g,frontMatter:()=>o,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"typedoc/sigma/src/rendering/functions/createEdgeCompoundProgram","title":"Function: createEdgeCompoundProgram()","description":"createEdgeCompoundProgram\\\\(programClasses, drawLabel?): EdgeProgramType\\\\","source":"@site/docs/typedoc/sigma/src/rendering/functions/createEdgeCompoundProgram.md","sourceDirName":"typedoc/sigma/src/rendering/functions","slug":"/typedoc/sigma/src/rendering/functions/createEdgeCompoundProgram","permalink":"/docs/typedoc/sigma/src/rendering/functions/createEdgeCompoundProgram","draft":false,"unlisted":false,"editUrl":"https://github.com/jacomyal/sigma.js/tree/main/packages/website/docs/typedoc/sigma/src/rendering/functions/createEdgeCompoundProgram.md","tags":[],"version":"current","frontMatter":{},"sidebar":"sigmaDocSidebar","previous":{"title":"createEdgeClampedProgram","permalink":"/docs/typedoc/sigma/src/rendering/functions/createEdgeClampedProgram"},"next":{"title":"createEdgeDoubleArrowProgram","permalink":"/docs/typedoc/sigma/src/rendering/functions/createEdgeDoubleArrowProgram"}}');var c=n(1085),d=n(1184);const o={},t="Function: createEdgeCompoundProgram()",i={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"programClasses",id:"programclasses",level:3},{value:"drawLabel?",id:"drawlabel",level:3},{value:"Returns",id:"returns",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.header,{children:(0,c.jsx)(r.h1,{id:"function-createedgecompoundprogram",children:"Function: createEdgeCompoundProgram()"})}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"createEdgeCompoundProgram"}),"<",(0,c.jsx)(r.code,{children:"N"}),", ",(0,c.jsx)(r.code,{children:"E"}),", ",(0,c.jsx)(r.code,{children:"G"}),">(",(0,c.jsx)(r.code,{children:"programClasses"}),", ",(0,c.jsx)(r.code,{children:"drawLabel"}),"?): ",(0,c.jsx)(r.a,{href:"/docs/typedoc/sigma/src/rendering/type-aliases/EdgeProgramType",children:(0,c.jsx)(r.code,{children:"EdgeProgramType"})}),"<",(0,c.jsx)(r.code,{children:"N"}),", ",(0,c.jsx)(r.code,{children:"E"}),", ",(0,c.jsx)(r.code,{children:"G"}),">"]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/jacomyal/sigma.js/blob/d32c4e5bfd4c5f49724ebc21bd786b01be555dac/packages/sigma/src/rendering/edge.ts#L120",children:"sigma/src/rendering/edge.ts:120"})]}),"\n",(0,c.jsx)(r.p,{children:"Helper function combining two or more programs into a single compound one.\nNote that this is more a quick & easy way to combine program than a really\nperformant option. More performant programs can be written entirely."}),"\n",(0,c.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"N"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"Attributes"})," = ",(0,c.jsx)(r.code,{children:"Attributes"})]}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"E"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"Attributes"})," = ",(0,c.jsx)(r.code,{children:"Attributes"})]}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"G"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"Attributes"})," = ",(0,c.jsx)(r.code,{children:"Attributes"})]}),"\n",(0,c.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsx)(r.h3,{id:"programclasses",children:"programClasses"}),"\n",(0,c.jsxs)(r.p,{children:["(",(0,c.jsx)(r.code,{children:"_gl"}),", ",(0,c.jsx)(r.code,{children:"_pickingBuffer"}),", ",(0,c.jsx)(r.code,{children:"_renderer"}),") => ",(0,c.jsx)(r.code,{children:"_EdgeProgramClass"}),"<",(0,c.jsx)(r.code,{children:"N"}),", ",(0,c.jsx)(r.code,{children:"E"}),", ",(0,c.jsx)(r.code,{children:"G"}),">[]"]}),"\n",(0,c.jsx)(r.p,{children:"Program classes to combine."}),"\n",(0,c.jsx)(r.h3,{id:"drawlabel",children:"drawLabel?"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/docs/typedoc/sigma/src/rendering/type-aliases/EdgeLabelDrawingFunction",children:(0,c.jsx)(r.code,{children:"EdgeLabelDrawingFunction"})}),"<",(0,c.jsx)(r.code,{children:"N"}),", ",(0,c.jsx)(r.code,{children:"E"}),", ",(0,c.jsx)(r.code,{children:"G"}),">"]}),"\n",(0,c.jsx)(r.p,{children:'An optional edge "draw label" function.'}),"\n",(0,c.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/docs/typedoc/sigma/src/rendering/type-aliases/EdgeProgramType",children:(0,c.jsx)(r.code,{children:"EdgeProgramType"})}),"<",(0,c.jsx)(r.code,{children:"N"}),", ",(0,c.jsx)(r.code,{children:"E"}),", ",(0,c.jsx)(r.code,{children:"G"}),">"]})]})}function g(e={}){const{wrapper:r}={...(0,d.R)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},1184:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>t});var s=n(4041);const c={},d=s.createContext(c);function o(e){const r=s.useContext(d);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(d.Provider,{value:r},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.