diff --git a/404.html b/404.html index fa577e3f..e7b92968 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | React Sigma - + diff --git a/assets/js/0e29f09e.28cc3cb2.js b/assets/js/0e29f09e.02b8ddd6.js similarity index 98% rename from assets/js/0e29f09e.28cc3cb2.js rename to assets/js/0e29f09e.02b8ddd6.js index ce668acf..f15f8e48 100644 --- a/assets/js/0e29f09e.28cc3cb2.js +++ b/assets/js/0e29f09e.02b8ddd6.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[701],{3060:(e,t,c)=>{c.r(t),c.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>n,toc:()=>o});var i=c(1085),l=c(1184);const s={id:"index",title:"@react-sigma/layout-circlepack",sidebar_label:"layout-circlepack",sidebar_position:.5,custom_edit_url:null},r=void 0,n={id:"api/layout-circlepack/index",title:"@react-sigma/layout-circlepack",description:"React Sigma module for layout circlepack.",source:"@site/docs/api/layout-circlepack/index.md",sourceDirName:"api/layout-circlepack",slug:"/api/layout-circlepack/",permalink:"/react-sigma/docs/api/layout-circlepack/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-circlepack",sidebar_label:"layout-circlepack",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"},next:{title:"layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"}},a={},o=[{value:"Hook",id:"hook",level:2},{value:"useLayoutCirclepack",id:"uselayoutcirclepack",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function d(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"React Sigma module for layout circlepack."}),"\n",(0,i.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,i.jsx)(t.h3,{id:"uselayoutcirclepack",children:"useLayoutCirclepack"}),"\n",(0,i.jsxs)(t.p,{children:["\u25b8 ",(0,i.jsx)(t.strong,{children:"useLayoutCirclepack"}),"(",(0,i.jsx)(t.code,{children:"settings?"}),"): ",(0,i.jsx)(t.code,{children:"Object"})]}),"\n",(0,i.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,i.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout.html#circlepack",children:"circlepack layout"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCirclepack({...});\n"})}),"\n",(0,i.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"settings?"})}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"CirclePackLayoutOptions"})})]})})]}),"\n",(0,i.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"Object"})}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"assign"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,i.jsx)(t.code,{children:"void"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"positions"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,i.jsx)(t.code,{children:"[node: string]"}),": { ",(0,i.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,i.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-circlepack/src/useLayoutCirclepack.ts#L13",children:"layout-circlepack/src/useLayoutCirclepack.ts:13"})})]})}function u(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,t,c)=>{c.d(t,{R:()=>r,x:()=>n});var i=c(4041);const l={},s=i.createContext(l);function r(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function n(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:r(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[701],{3060:(e,t,c)=>{c.r(t),c.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>n,toc:()=>o});var i=c(1085),l=c(1184);const s={id:"index",title:"@react-sigma/layout-circlepack",sidebar_label:"layout-circlepack",sidebar_position:.5,custom_edit_url:null},r=void 0,n={id:"api/layout-circlepack/index",title:"@react-sigma/layout-circlepack",description:"React Sigma module for layout circlepack.",source:"@site/docs/api/layout-circlepack/index.md",sourceDirName:"api/layout-circlepack",slug:"/api/layout-circlepack/",permalink:"/react-sigma/docs/api/layout-circlepack/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-circlepack",sidebar_label:"layout-circlepack",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"},next:{title:"layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"}},a={},o=[{value:"Hook",id:"hook",level:2},{value:"useLayoutCirclepack",id:"uselayoutcirclepack",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function d(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"React Sigma module for layout circlepack."}),"\n",(0,i.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,i.jsx)(t.h3,{id:"uselayoutcirclepack",children:"useLayoutCirclepack"}),"\n",(0,i.jsxs)(t.p,{children:["\u25b8 ",(0,i.jsx)(t.strong,{children:"useLayoutCirclepack"}),"(",(0,i.jsx)(t.code,{children:"settings?"}),"): ",(0,i.jsx)(t.code,{children:"Object"})]}),"\n",(0,i.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,i.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout.html#circlepack",children:"circlepack layout"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCirclepack({...});\n"})}),"\n",(0,i.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"settings?"})}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"CirclePackLayoutOptions"})})]})})]}),"\n",(0,i.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"Object"})}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"assign"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,i.jsx)(t.code,{children:"void"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"positions"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,i.jsx)(t.code,{children:"[node: string]"}),": { ",(0,i.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,i.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-circlepack/src/useLayoutCirclepack.ts#L13",children:"layout-circlepack/src/useLayoutCirclepack.ts:13"})})]})}function u(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,t,c)=>{c.d(t,{R:()=>r,x:()=>n});var i=c(4041);const l={},s=i.createContext(l);function r(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function n(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:r(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1aa56bec.b185126c.js b/assets/js/1aa56bec.cd5aaf76.js similarity index 97% rename from assets/js/1aa56bec.b185126c.js rename to assets/js/1aa56bec.cd5aaf76.js index 28dd7f4c..c8e9012b 100644 --- a/assets/js/1aa56bec.b185126c.js +++ b/assets/js/1aa56bec.cd5aaf76.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[711],{2348:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>n,metadata:()=>i,toc:()=>d});var s=r(1085),l=r(1184);const n={id:"index",title:"@react-sigma/layout-force",sidebar_label:"layout-force",sidebar_position:.5,custom_edit_url:null},o=void 0,i={id:"api/layout-force/index",title:"@react-sigma/layout-force",description:"Component",source:"@site/docs/api/layout-force/index.md",sourceDirName:"api/layout-force",slug:"/api/layout-force/",permalink:"/react-sigma/docs/api/layout-force/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-force",sidebar_label:"layout-force",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"},next:{title:"layout-noverlap",permalink:"/react-sigma/docs/api/layout-noverlap/"}},c={},d=[{value:"Component",id:"component",level:2},{value:"LayoutForceControl",id:"layoutforcecontrol",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Hook",id:"hook",level:2},{value:"useLayoutForce",id:"uselayoutforce",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useWorkerLayoutForce",id:"useworkerlayoutforce",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Other",id:"other",level:2},{value:"LayoutForceControlProps",id:"layoutforcecontrolprops",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"component",children:"Component"}),"\n",(0,s.jsx)(t.h3,{id:"layoutforcecontrol",children:"LayoutForceControl"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"LayoutForceControl"}),"(",(0,s.jsx)(t.code,{children:"props"}),", ",(0,s.jsx)(t.code,{children:"context?"}),"): ",(0,s.jsx)(t.code,{children:"ReactNode"})]}),"\n",(0,s.jsx)(t.p,{children:"Component that display a button to start/stop the layout."}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"props"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.a,{href:"#layoutforcecontrolprops",children:(0,s.jsx)(t.code,{children:"LayoutForceControlProps"})})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"context?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"any"})})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"ReactNode"})}),"\n",(0,s.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-force/src/LayoutForceControl.tsx#L22",children:"packages/layout-force/src/LayoutForceControl.tsx:22"})}),"\n",(0,s.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,s.jsx)(t.h3,{id:"uselayoutforce",children:"useLayoutForce"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"useLayoutForce"}),"(",(0,s.jsx)(t.code,{children:"settings?"}),"): ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,s.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForce(...);\n"})}),"\n",(0,s.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"settings?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"ForceLayoutParameters"})})]})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Object"})}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"assign"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"positions"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,s.jsx)(t.code,{children:"[node: string]"}),": { ",(0,s.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,s.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-force/src/useLayoutForce.ts#L13",children:"packages/layout-force/src/useLayoutForce.ts:13"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"useworkerlayoutforce",children:"useWorkerLayoutForce"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"useWorkerLayoutForce"}),"(",(0,s.jsx)(t.code,{children:"settings"}),"): ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsxs)(t.p,{children:["React hook that helps you to manage worker of ",(0,s.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForce(...);\n"})}),"\n",(0,s.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"settings"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"ForceLayoutSupervisorParameters"})})]})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Object"})}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"isRunning"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"boolean"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"kill"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"start"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"stop"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-force/src/useWorkerLayoutForce.ts#L13",children:"packages/layout-force/src/useWorkerLayoutForce.ts:13"})}),"\n",(0,s.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,s.jsx)(t.h3,{id:"layoutforcecontrolprops",children:"LayoutForceControlProps"}),"\n",(0,s.jsxs)(t.p,{children:["\u01ac ",(0,s.jsx)(t.strong,{children:"LayoutForceControlProps"}),": ",(0,s.jsx)(t.code,{children:"Omit"}),"<",(0,s.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,s.jsx)(t.code,{children:"ForceLayoutSupervisorParameters"}),">, ",(0,s.jsx)(t.code,{children:'"layout"'})," | ",(0,s.jsx)(t.code,{children:'"settings"'}),"> & { ",(0,s.jsx)(t.code,{children:"settings?"}),": ",(0,s.jsx)(t.code,{children:"ForceLayoutSupervisorParameters"})," }"]}),"\n",(0,s.jsxs)(t.p,{children:["Properties for ",(0,s.jsx)(t.code,{children:"ForceDirectedControl"})," component"]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-force/src/LayoutForceControl.tsx#L10",children:"packages/layout-force/src/LayoutForceControl.tsx:10"})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>i});var s=r(4041);const l={},n=s.createContext(l);function o(e){const t=s.useContext(n);return s.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(l):e.components||l:o(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[711],{2348:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>n,metadata:()=>i,toc:()=>d});var s=r(1085),l=r(1184);const n={id:"index",title:"@react-sigma/layout-force",sidebar_label:"layout-force",sidebar_position:.5,custom_edit_url:null},o=void 0,i={id:"api/layout-force/index",title:"@react-sigma/layout-force",description:"Component",source:"@site/docs/api/layout-force/index.md",sourceDirName:"api/layout-force",slug:"/api/layout-force/",permalink:"/react-sigma/docs/api/layout-force/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-force",sidebar_label:"layout-force",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"},next:{title:"layout-noverlap",permalink:"/react-sigma/docs/api/layout-noverlap/"}},c={},d=[{value:"Component",id:"component",level:2},{value:"LayoutForceControl",id:"layoutforcecontrol",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Hook",id:"hook",level:2},{value:"useLayoutForce",id:"uselayoutforce",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useWorkerLayoutForce",id:"useworkerlayoutforce",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Other",id:"other",level:2},{value:"LayoutForceControlProps",id:"layoutforcecontrolprops",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"component",children:"Component"}),"\n",(0,s.jsx)(t.h3,{id:"layoutforcecontrol",children:"LayoutForceControl"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"LayoutForceControl"}),"(",(0,s.jsx)(t.code,{children:"props"}),", ",(0,s.jsx)(t.code,{children:"context?"}),"): ",(0,s.jsx)(t.code,{children:"ReactNode"})]}),"\n",(0,s.jsx)(t.p,{children:"Component that display a button to start/stop the layout."}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"props"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.a,{href:"#layoutforcecontrolprops",children:(0,s.jsx)(t.code,{children:"LayoutForceControlProps"})})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"context?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"any"})})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"ReactNode"})}),"\n",(0,s.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-force/src/LayoutForceControl.tsx#L22",children:"packages/layout-force/src/LayoutForceControl.tsx:22"})}),"\n",(0,s.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,s.jsx)(t.h3,{id:"uselayoutforce",children:"useLayoutForce"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"useLayoutForce"}),"(",(0,s.jsx)(t.code,{children:"settings?"}),"): ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,s.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForce(...);\n"})}),"\n",(0,s.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"settings?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"ForceLayoutParameters"})})]})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Object"})}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"assign"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"positions"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,s.jsx)(t.code,{children:"[node: string]"}),": { ",(0,s.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,s.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-force/src/useLayoutForce.ts#L13",children:"packages/layout-force/src/useLayoutForce.ts:13"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"useworkerlayoutforce",children:"useWorkerLayoutForce"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"useWorkerLayoutForce"}),"(",(0,s.jsx)(t.code,{children:"settings"}),"): ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsxs)(t.p,{children:["React hook that helps you to manage worker of ",(0,s.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForce(...);\n"})}),"\n",(0,s.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"settings"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"ForceLayoutSupervisorParameters"})})]})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Object"})}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"isRunning"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"boolean"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"kill"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"start"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"stop"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-force/src/useWorkerLayoutForce.ts#L13",children:"packages/layout-force/src/useWorkerLayoutForce.ts:13"})}),"\n",(0,s.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,s.jsx)(t.h3,{id:"layoutforcecontrolprops",children:"LayoutForceControlProps"}),"\n",(0,s.jsxs)(t.p,{children:["\u01ac ",(0,s.jsx)(t.strong,{children:"LayoutForceControlProps"}),": ",(0,s.jsx)(t.code,{children:"Omit"}),"<",(0,s.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,s.jsx)(t.code,{children:"ForceLayoutSupervisorParameters"}),">, ",(0,s.jsx)(t.code,{children:'"layout"'})," | ",(0,s.jsx)(t.code,{children:'"settings"'}),"> & { ",(0,s.jsx)(t.code,{children:"settings?"}),": ",(0,s.jsx)(t.code,{children:"ForceLayoutSupervisorParameters"})," }"]}),"\n",(0,s.jsxs)(t.p,{children:["Properties for ",(0,s.jsx)(t.code,{children:"ForceDirectedControl"})," component"]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-force/src/LayoutForceControl.tsx#L10",children:"packages/layout-force/src/LayoutForceControl.tsx:10"})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>i});var s=r(4041);const l={},n=s.createContext(l);function o(e){const t=s.useContext(n);return s.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(l):e.components||l:o(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28a50278.03628e3f.js b/assets/js/28a50278.03911ebb.js similarity index 93% rename from assets/js/28a50278.03628e3f.js rename to assets/js/28a50278.03911ebb.js index da9fca73..0195f310 100644 --- a/assets/js/28a50278.03628e3f.js +++ b/assets/js/28a50278.03911ebb.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[784],{6092:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var t=o(1085),s=o(1184);const r={id:"ZoomControlProps",title:"Interface: ZoomControlProps",sidebar_label:"ZoomControlProps",sidebar_position:0,custom_edit_url:null},i=void 0,l={id:"api/core/interfaces/ZoomControlProps",title:"Interface: ZoomControlProps",description:"Properties for ZoomControl component",source:"@site/docs/api/core/interfaces/ZoomControlProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ZoomControlProps",title:"Interface: ZoomControlProps",sidebar_label:"ZoomControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"SigmaContextInterface",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"},next:{title:"layout-core",permalink:"/react-sigma/docs/api/layout-core/"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"animationDuration",id:"animationduration",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["Properties for ",(0,t.jsx)(n.code,{children:"ZoomControl"})," component"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"animationduration",children:"animationDuration"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"animationDuration"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n",(0,t.jsx)(n.p,{children:"Number of ms for the zoom animation (default is 200ms)"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ZoomControl.tsx#L27",children:"packages/core/src/components/controls/ZoomControl.tsx:27"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"children"}),": [",(0,t.jsx)(n.code,{children:"Element"}),", ",(0,t.jsx)(n.code,{children:"Element"}),", ",(0,t.jsx)(n.code,{children:"Element"}),"]"]}),"\n",(0,t.jsx)(n.p,{children:'It\'s possible to customize the button, by passing to JSX Element.\nFirst one is for the "zoom in", second for "zoom out" and third for "view whole graph".\nExample :'}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ZoomControl.tsx#L41",children:"packages/core/src/components/controls/ZoomControl.tsx:41"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"className"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"HTML class that will be added to all div button wrapper"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ZoomControl.tsx#L17",children:"packages/core/src/components/controls/ZoomControl.tsx:17"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"labels"}),": ",(0,t.jsx)(n.code,{children:"Object"})]}),"\n",(0,t.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,t.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"reset"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"string"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomIn"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"string"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomOut"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ZoomControl.tsx#L47",children:"packages/core/src/components/controls/ZoomControl.tsx:47"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"style"}),": ",(0,t.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,t.jsx)(n.p,{children:"HTML CSS style that will be added to all div button wrapper"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ZoomControl.tsx#L22",children:"packages/core/src/components/controls/ZoomControl.tsx:22"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},1184:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>l});var t=o(4041);const s={},r=t.createContext(s);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[784],{6092:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var t=o(1085),s=o(1184);const r={id:"ZoomControlProps",title:"Interface: ZoomControlProps",sidebar_label:"ZoomControlProps",sidebar_position:0,custom_edit_url:null},i=void 0,l={id:"api/core/interfaces/ZoomControlProps",title:"Interface: ZoomControlProps",description:"Properties for ZoomControl component",source:"@site/docs/api/core/interfaces/ZoomControlProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ZoomControlProps",title:"Interface: ZoomControlProps",sidebar_label:"ZoomControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"SigmaContextInterface",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"},next:{title:"layout-core",permalink:"/react-sigma/docs/api/layout-core/"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"animationDuration",id:"animationduration",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["Properties for ",(0,t.jsx)(n.code,{children:"ZoomControl"})," component"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"animationduration",children:"animationDuration"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"animationDuration"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n",(0,t.jsx)(n.p,{children:"Number of ms for the zoom animation (default is 200ms)"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ZoomControl.tsx#L27",children:"packages/core/src/components/controls/ZoomControl.tsx:27"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"children"}),": [",(0,t.jsx)(n.code,{children:"Element"}),", ",(0,t.jsx)(n.code,{children:"Element"}),", ",(0,t.jsx)(n.code,{children:"Element"}),"]"]}),"\n",(0,t.jsx)(n.p,{children:'It\'s possible to customize the button, by passing to JSX Element.\nFirst one is for the "zoom in", second for "zoom out" and third for "view whole graph".\nExample :'}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ZoomControl.tsx#L41",children:"packages/core/src/components/controls/ZoomControl.tsx:41"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"className"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"HTML class that will be added to all div button wrapper"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ZoomControl.tsx#L17",children:"packages/core/src/components/controls/ZoomControl.tsx:17"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"labels"}),": ",(0,t.jsx)(n.code,{children:"Object"})]}),"\n",(0,t.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,t.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"reset"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"string"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomIn"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"string"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomOut"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ZoomControl.tsx#L47",children:"packages/core/src/components/controls/ZoomControl.tsx:47"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.code,{children:"Optional"})," ",(0,t.jsx)(n.strong,{children:"style"}),": ",(0,t.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,t.jsx)(n.p,{children:"HTML CSS style that will be added to all div button wrapper"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ZoomControl.tsx#L22",children:"packages/core/src/components/controls/ZoomControl.tsx:22"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},1184:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>l});var t=o(4041);const s={},r=t.createContext(s);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2c32c100.bfd23e93.js b/assets/js/2c32c100.b385ba50.js similarity index 97% rename from assets/js/2c32c100.bfd23e93.js rename to assets/js/2c32c100.b385ba50.js index 5af40e91..a62d5edc 100644 --- a/assets/js/2c32c100.bfd23e93.js +++ b/assets/js/2c32c100.b385ba50.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[441],{7079:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>l,metadata:()=>d,toc:()=>h});var t=s(1085),r=s(1184);const l={id:"index",title:"@react-sigma/core",sidebar_label:"core",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"api/core/index",title:"@react-sigma/core",description:"Main React Sigma module that contains all the standard components & hooks to display a graph in react.",source:"@site/docs/api/core/index.md",sourceDirName:"api/core",slug:"/api/core/",permalink:"/react-sigma/docs/api/core/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/core",sidebar_label:"core",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"Project structure",permalink:"/react-sigma/docs/api"},next:{title:"ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"}},c={},h=[{value:"Interfaces",id:"interfaces",level:2},{value:"Component",id:"component",level:2},{value:"ControlsContainer",id:"controlscontainer",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"FullScreenControl",id:"fullscreencontrol",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"SearchControl",id:"searchcontrol",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"ZoomControl",id:"zoomcontrol",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Hook",id:"hook",level:2},{value:"useCamera",id:"usecamera",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useFullScreen",id:"usefullscreen",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useLoadGraph",id:"useloadgraph",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Defined in",id:"defined-in-6",level:4},{value:"useRegisterEvents",id:"useregisterevents",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Defined in",id:"defined-in-7",level:4},{value:"useSetSettings",id:"usesetsettings",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-8",level:4},{value:"useSigma",id:"usesigma",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useSigmaContext",id:"usesigmacontext",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"EventHandlers",id:"eventhandlers",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"GraphType",id:"graphtype",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"SigmaContainer",id:"sigmacontainer",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getUniqueKey",id:"getuniquekey",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isEqual",id:"isequal",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-15",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"Main React Sigma module that contains all the standard components & hooks to display a graph in react."}),"\n",(0,t.jsx)(n.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",children:"ControlsContainerProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",children:"FullScreenControlProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SearchControlProps",children:"SearchControlProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps",children:"SigmaContainerProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:"SigmaContextInterface"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",children:"ZoomControlProps"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"component",children:"Component"}),"\n",(0,t.jsx)(n.h3,{id:"controlscontainer",children:"ControlsContainer"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"ControlsContainer"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"ControlsContainer"})," is just a wrapper for other control components.\nIt defines their position and also their style with its CSS class ",(0,t.jsx)(n.code,{children:"react-sigma-controls"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:'\n \n \n \n\n'})}),"\n",(0,t.jsx)(n.p,{children:"See [[ControlsContainerProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",children:(0,t.jsx)(n.code,{children:"ControlsContainerProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ControlsContainer.tsx#L44",children:"packages/core/src/components/controls/ControlsContainer.tsx:44"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"fullscreencontrol",children:"FullScreenControl"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"FullScreenControl"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"FullScreenControl"})," create a UI button that allows the user to display the graph in fullscreen"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[FullScreenControlProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",children:(0,t.jsx)(n.code,{children:"FullScreenControlProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L67",children:"packages/core/src/components/controls/FullScreenControl.tsx:67"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"searchcontrol",children:"SearchControl"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"SearchControl"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"SearchControl"})," create an input text where user can search a node in the graph by its label.\nThere is an autocomplete based on includes & lower case.\nWhen a node is found, the graph will focus on the highlighted node"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[SearchControlProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SearchControlProps",children:(0,t.jsx)(n.code,{children:"SearchControlProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/SearchControl.tsx#L53",children:"packages/core/src/components/controls/SearchControl.tsx:53"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"zoomcontrol",children:"ZoomControl"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"ZoomControl"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"ZoomControl"})," create three UI buttons that allows the user to"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"zoom in"}),"\n",(0,t.jsx)(n.li,{children:"zoom out"}),"\n",(0,t.jsx)(n.li,{children:"reset zoom (ie. see the whole graph)"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[ZoomControlProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",children:(0,t.jsx)(n.code,{children:"ZoomControlProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ZoomControl.tsx#L67",children:"packages/core/src/components/controls/ZoomControl.tsx:67"})}),"\n",(0,t.jsx)(n.h2,{id:"hook",children:"Hook"}),"\n",(0,t.jsx)(n.h3,{id:"usecamera",children:"useCamera"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useCamera"}),"(",(0,t.jsx)(n.code,{children:"options?"}),"): ",(0,t.jsx)(n.code,{children:"Object"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to manage the camera."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const {zoomIn, zoomOut, reset, goto, gotoNode } = useCamera();\n"})}),"\n",(0,t.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"options?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"CameraOptions"})})]})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Object"})}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"goto"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"state"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"CameraState"}),">, ",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"AnimateOptions"}),">) => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"gotoNode"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"nodeKey"}),": ",(0,t.jsx)(n.code,{children:"string"}),", ",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"AnimateOptions"}),">) => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"reset"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"AnimateOptions"}),">) => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomIn"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"CameraOptions"}),") => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomOut"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"CameraOptions"}),") => ",(0,t.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/useCamera.ts#L19",children:"packages/core/src/hooks/useCamera.ts:19"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usefullscreen",children:"useFullScreen"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useFullScreen"}),"(",(0,t.jsx)(n.code,{children:"container?"}),"): ",(0,t.jsx)(n.code,{children:"Object"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to set graph in fullmode."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const {toggle, isFullScreen} = useFullscreen();\n"})}),"\n",(0,t.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"container?"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"null"})," | ",(0,t.jsx)(n.code,{children:"HTMLElement"})]})]})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Object"})}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"isFullScreen"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"boolean"})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"toggle"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,t.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/useFullScreen.ts#L22",children:"packages/core/src/hooks/useFullScreen.ts:22"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"useloadgraph",children:"useLoadGraph"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useLoadGraph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): (",(0,t.jsx)(n.code,{children:"graph"}),": ",(0,t.jsx)(n.code,{children:"Graph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">, ",(0,t.jsx)(n.code,{children:"clear?"}),": ",(0,t.jsx)(n.code,{children:"boolean"}),") => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsxs)(n.p,{children:["React hook that helps you to load a graph.\nIf a graph was previously loaded in Sigma/Graphology, per default it is cleared.\nYou can change this behaviour by settings the parameter ",(0,t.jsx)(n.code,{children:"clear"})," to false."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const loadGraph = useLoadGraph();\n...\nuseEffect(() => {\n loadGraph(erdosRenyi(UndirectedGraph, { order: 100, probability: 0.2 }), true);\n}, []);\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"fn"})}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 (",(0,t.jsx)(n.code,{children:"graph"}),", ",(0,t.jsx)(n.code,{children:"clear?"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"graph"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"Graph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"clear?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"boolean"})})]})]})]}),"\n",(0,t.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/useLoadGraph.ts#L21",children:"packages/core/src/hooks/useLoadGraph.ts:21"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"useregisterevents",children:"useRegisterEvents"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useRegisterEvents"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): (",(0,t.jsx)(n.code,{children:"eventHandlers"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.a,{href:"#eventhandlers",children:(0,t.jsx)(n.code,{children:"EventHandlers"})}),">) => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to listen Sigma\u2019s events.\nIt handles for you all the lifecyle of listener (ie. on / remove)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const registerEvents = useRegisterEvents();\nconst [setHoveredNode,setHoveredNode] = useState(null);\n...\nuseEffect(() => {\n registerEvents({\n enterNode: event => setHoveredNode(event.node),\n leaveNode: event => setHoveredNode(null),\n });\n}, []);\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"fn"})}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 (",(0,t.jsx)(n.code,{children:"eventHandlers"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"eventHandlers"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.a,{href:"#eventhandlers",children:(0,t.jsx)(n.code,{children:"EventHandlers"})}),">"]})]})})]}),"\n",(0,t.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/useRegisterEvents.ts#L83",children:"packages/core/src/hooks/useRegisterEvents.ts:83"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usesetsettings",children:"useSetSettings"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useSetSettings"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): (",(0,t.jsx)(n.code,{children:"newSettings"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"Settings"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">>) => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to update Sigma\u2019s settings."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const setSettings = useSetSettings();\n...\nuseEffect(() => {\n setSettings({\n hideEdgesOnMove: true,\n hideLabelsOnMove: true,\n });\n}, []);\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"fn"})}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 (",(0,t.jsx)(n.code,{children:"newSettings"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"newSettings"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"Settings"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">>"]})]})})]}),"\n",(0,t.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/useSetSettings.ts#L22",children:"packages/core/src/hooks/useSetSettings.ts:22"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usesigma",children:"useSigma"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useSigma"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): ",(0,t.jsx)(n.code,{children:"Sigma"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"React hook to retrieve the sigma instance (from the context)."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const sigma = useSigma();\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-3",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Sigma"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/useSigma.ts#L14",children:"packages/core/src/hooks/useSigma.ts:14"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usesigmacontext",children:"useSigmaContext"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useSigmaContext"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): ",(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,t.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"React hook that store the sigma and html container reference."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const {sigma, container} = useSigmaContext();\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[SigmaContextInterface]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-4",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,t.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/context.ts#L34",children:"packages/core/src/hooks/context.ts:34"})}),"\n",(0,t.jsx)(n.h2,{id:"other",children:"Other"}),"\n",(0,t.jsx)(n.h3,{id:"eventhandlers",children:"EventHandlers"}),"\n",(0,t.jsxs)(n.p,{children:["\u01ac ",(0,t.jsx)(n.strong,{children:"EventHandlers"}),": ",(0,t.jsx)(n.code,{children:"SigmaEvents"})," & ",(0,t.jsx)(n.code,{children:"TouchCaptorEvents"})," & ",(0,t.jsx)(n.code,{children:"MouseCaptorEvents"})," & ",(0,t.jsx)(n.code,{children:"CameraEvents"})]}),"\n",(0,t.jsx)(n.p,{children:"Sigma's events"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/types.ts#L7",children:"packages/core/src/types.ts:7"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"graphtype",children:"GraphType"}),"\n",(0,t.jsxs)(n.p,{children:["\u01ac ",(0,t.jsx)(n.strong,{children:"GraphType"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">: ",(0,t.jsx)(n.code,{children:"AbstractGraph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),"> | ",(0,t.jsx)(n.code,{children:"GraphConstructor"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-5",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/types.ts#L17",children:"packages/core/src/types.ts:17"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sigmacontainer",children:"SigmaContainer"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"SigmaContainer"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(",(0,t.jsx)(n.code,{children:"props"}),"): ",(0,t.jsx)(n.code,{children:"ReactElement"}),"<",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"JSXElementConstructor"}),"<",(0,t.jsx)(n.code,{children:"any"}),">>"]}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-6",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps",children:(0,t.jsx)(n.code,{children:"SigmaContainerProps"})}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),"> & { ",(0,t.jsx)(n.code,{children:"children?"}),": ",(0,t.jsx)(n.code,{children:"ReactNode"})," } & ",(0,t.jsx)(n.code,{children:"RefAttributes"}),"<",(0,t.jsx)(n.code,{children:"null"})," | ",(0,t.jsx)(n.code,{children:"default"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">>"]})]})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"ReactElement"}),"<",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"JSXElementConstructor"}),"<",(0,t.jsx)(n.code,{children:"any"}),">>"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/SigmaContainer.tsx#L141",children:"packages/core/src/components/SigmaContainer.tsx:141"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"getuniquekey",children:"getUniqueKey"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"getUniqueKey"}),"(): ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/utils.ts#L1",children:"packages/core/src/utils.ts:1"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"isequal",children:"isEqual"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"isEqual"}),"(",(0,t.jsx)(n.code,{children:"x"}),", ",(0,t.jsx)(n.code,{children:"y"}),"): ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n",(0,t.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"x"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"unknown"})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"y"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"unknown"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/utils.ts#L5",children:"packages/core/src/utils.ts:5"})})]})}function x(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>d});var t=s(4041);const r={},l=t.createContext(r);function i(e){const n=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[441],{7079:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>l,metadata:()=>d,toc:()=>h});var t=s(1085),r=s(1184);const l={id:"index",title:"@react-sigma/core",sidebar_label:"core",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"api/core/index",title:"@react-sigma/core",description:"Main React Sigma module that contains all the standard components & hooks to display a graph in react.",source:"@site/docs/api/core/index.md",sourceDirName:"api/core",slug:"/api/core/",permalink:"/react-sigma/docs/api/core/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/core",sidebar_label:"core",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"Project structure",permalink:"/react-sigma/docs/api"},next:{title:"ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"}},c={},h=[{value:"Interfaces",id:"interfaces",level:2},{value:"Component",id:"component",level:2},{value:"ControlsContainer",id:"controlscontainer",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"FullScreenControl",id:"fullscreencontrol",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"SearchControl",id:"searchcontrol",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"ZoomControl",id:"zoomcontrol",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Hook",id:"hook",level:2},{value:"useCamera",id:"usecamera",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useFullScreen",id:"usefullscreen",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useLoadGraph",id:"useloadgraph",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Defined in",id:"defined-in-6",level:4},{value:"useRegisterEvents",id:"useregisterevents",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Defined in",id:"defined-in-7",level:4},{value:"useSetSettings",id:"usesetsettings",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-8",level:4},{value:"useSigma",id:"usesigma",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useSigmaContext",id:"usesigmacontext",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"EventHandlers",id:"eventhandlers",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"GraphType",id:"graphtype",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"SigmaContainer",id:"sigmacontainer",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getUniqueKey",id:"getuniquekey",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isEqual",id:"isequal",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-15",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"Main React Sigma module that contains all the standard components & hooks to display a graph in react."}),"\n",(0,t.jsx)(n.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",children:"ControlsContainerProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",children:"FullScreenControlProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SearchControlProps",children:"SearchControlProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps",children:"SigmaContainerProps"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:"SigmaContextInterface"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",children:"ZoomControlProps"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"component",children:"Component"}),"\n",(0,t.jsx)(n.h3,{id:"controlscontainer",children:"ControlsContainer"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"ControlsContainer"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"ControlsContainer"})," is just a wrapper for other control components.\nIt defines their position and also their style with its CSS class ",(0,t.jsx)(n.code,{children:"react-sigma-controls"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:'\n \n \n \n\n'})}),"\n",(0,t.jsx)(n.p,{children:"See [[ControlsContainerProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",children:(0,t.jsx)(n.code,{children:"ControlsContainerProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ControlsContainer.tsx#L44",children:"packages/core/src/components/controls/ControlsContainer.tsx:44"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"fullscreencontrol",children:"FullScreenControl"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"FullScreenControl"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"FullScreenControl"})," create a UI button that allows the user to display the graph in fullscreen"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[FullScreenControlProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",children:(0,t.jsx)(n.code,{children:"FullScreenControlProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L67",children:"packages/core/src/components/controls/FullScreenControl.tsx:67"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"searchcontrol",children:"SearchControl"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"SearchControl"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"SearchControl"})," create an input text where user can search a node in the graph by its label.\nThere is an autocomplete based on includes & lower case.\nWhen a node is found, the graph will focus on the highlighted node"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[SearchControlProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SearchControlProps",children:(0,t.jsx)(n.code,{children:"SearchControlProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/SearchControl.tsx#L53",children:"packages/core/src/components/controls/SearchControl.tsx:53"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"zoomcontrol",children:"ZoomControl"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"ZoomControl"}),"(",(0,t.jsx)(n.code,{children:"props"}),", ",(0,t.jsx)(n.code,{children:"context?"}),"): ",(0,t.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"ZoomControl"})," create three UI buttons that allows the user to"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"zoom in"}),"\n",(0,t.jsx)(n.li,{children:"zoom out"}),"\n",(0,t.jsx)(n.li,{children:"reset zoom (ie. see the whole graph)"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[ZoomControlProps]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",children:(0,t.jsx)(n.code,{children:"ZoomControlProps"})})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"context?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ZoomControl.tsx#L67",children:"packages/core/src/components/controls/ZoomControl.tsx:67"})}),"\n",(0,t.jsx)(n.h2,{id:"hook",children:"Hook"}),"\n",(0,t.jsx)(n.h3,{id:"usecamera",children:"useCamera"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useCamera"}),"(",(0,t.jsx)(n.code,{children:"options?"}),"): ",(0,t.jsx)(n.code,{children:"Object"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to manage the camera."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const {zoomIn, zoomOut, reset, goto, gotoNode } = useCamera();\n"})}),"\n",(0,t.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"options?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"CameraOptions"})})]})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Object"})}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"goto"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"state"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"CameraState"}),">, ",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"AnimateOptions"}),">) => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"gotoNode"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"nodeKey"}),": ",(0,t.jsx)(n.code,{children:"string"}),", ",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"AnimateOptions"}),">) => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"reset"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"AnimateOptions"}),">) => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomIn"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"CameraOptions"}),") => ",(0,t.jsx)(n.code,{children:"void"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"zoomOut"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,t.jsx)(n.code,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"CameraOptions"}),") => ",(0,t.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/useCamera.ts#L19",children:"packages/core/src/hooks/useCamera.ts:19"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usefullscreen",children:"useFullScreen"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useFullScreen"}),"(",(0,t.jsx)(n.code,{children:"container?"}),"): ",(0,t.jsx)(n.code,{children:"Object"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to set graph in fullmode."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const {toggle, isFullScreen} = useFullscreen();\n"})}),"\n",(0,t.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"container?"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"null"})," | ",(0,t.jsx)(n.code,{children:"HTMLElement"})]})]})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Object"})}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"isFullScreen"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"boolean"})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"toggle"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,t.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/useFullScreen.ts#L22",children:"packages/core/src/hooks/useFullScreen.ts:22"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"useloadgraph",children:"useLoadGraph"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useLoadGraph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): (",(0,t.jsx)(n.code,{children:"graph"}),": ",(0,t.jsx)(n.code,{children:"Graph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">, ",(0,t.jsx)(n.code,{children:"clear?"}),": ",(0,t.jsx)(n.code,{children:"boolean"}),") => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsxs)(n.p,{children:["React hook that helps you to load a graph.\nIf a graph was previously loaded in Sigma/Graphology, per default it is cleared.\nYou can change this behaviour by settings the parameter ",(0,t.jsx)(n.code,{children:"clear"})," to false."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const loadGraph = useLoadGraph();\n...\nuseEffect(() => {\n loadGraph(erdosRenyi(UndirectedGraph, { order: 100, probability: 0.2 }), true);\n}, []);\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"fn"})}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 (",(0,t.jsx)(n.code,{children:"graph"}),", ",(0,t.jsx)(n.code,{children:"clear?"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"graph"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"Graph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"clear?"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"boolean"})})]})]})]}),"\n",(0,t.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/useLoadGraph.ts#L21",children:"packages/core/src/hooks/useLoadGraph.ts:21"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"useregisterevents",children:"useRegisterEvents"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useRegisterEvents"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): (",(0,t.jsx)(n.code,{children:"eventHandlers"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.a,{href:"#eventhandlers",children:(0,t.jsx)(n.code,{children:"EventHandlers"})}),">) => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to listen Sigma\u2019s events.\nIt handles for you all the lifecyle of listener (ie. on / remove)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const registerEvents = useRegisterEvents();\nconst [setHoveredNode,setHoveredNode] = useState(null);\n...\nuseEffect(() => {\n registerEvents({\n enterNode: event => setHoveredNode(event.node),\n leaveNode: event => setHoveredNode(null),\n });\n}, []);\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"fn"})}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 (",(0,t.jsx)(n.code,{children:"eventHandlers"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"eventHandlers"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.a,{href:"#eventhandlers",children:(0,t.jsx)(n.code,{children:"EventHandlers"})}),">"]})]})})]}),"\n",(0,t.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/useRegisterEvents.ts#L83",children:"packages/core/src/hooks/useRegisterEvents.ts:83"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usesetsettings",children:"useSetSettings"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useSetSettings"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): (",(0,t.jsx)(n.code,{children:"newSettings"}),": ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"Settings"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">>) => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.p,{children:"React hook that helps you to update Sigma\u2019s settings."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const setSettings = useSetSettings();\n...\nuseEffect(() => {\n setSettings({\n hideEdgesOnMove: true,\n hideLabelsOnMove: true,\n });\n}, []);\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"fn"})}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 (",(0,t.jsx)(n.code,{children:"newSettings"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n",(0,t.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"newSettings"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"Settings"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">>"]})]})})]}),"\n",(0,t.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/useSetSettings.ts#L22",children:"packages/core/src/hooks/useSetSettings.ts:22"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usesigma",children:"useSigma"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useSigma"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): ",(0,t.jsx)(n.code,{children:"Sigma"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"React hook to retrieve the sigma instance (from the context)."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const sigma = useSigma();\n"})}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-3",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Sigma"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/useSigma.ts#L14",children:"packages/core/src/hooks/useSigma.ts:14"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"usesigmacontext",children:"useSigmaContext"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"useSigmaContext"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(): ",(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,t.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"React hook that store the sigma and html container reference."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const {sigma, container} = useSigmaContext();\n"})}),"\n",(0,t.jsx)(n.p,{children:"See [[SigmaContextInterface]] for more information."}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-4",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,t.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/context.ts#L34",children:"packages/core/src/hooks/context.ts:34"})}),"\n",(0,t.jsx)(n.h2,{id:"other",children:"Other"}),"\n",(0,t.jsx)(n.h3,{id:"eventhandlers",children:"EventHandlers"}),"\n",(0,t.jsxs)(n.p,{children:["\u01ac ",(0,t.jsx)(n.strong,{children:"EventHandlers"}),": ",(0,t.jsx)(n.code,{children:"SigmaEvents"})," & ",(0,t.jsx)(n.code,{children:"TouchCaptorEvents"})," & ",(0,t.jsx)(n.code,{children:"MouseCaptorEvents"})," & ",(0,t.jsx)(n.code,{children:"CameraEvents"})]}),"\n",(0,t.jsx)(n.p,{children:"Sigma's events"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/types.ts#L7",children:"packages/core/src/types.ts:7"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"graphtype",children:"GraphType"}),"\n",(0,t.jsxs)(n.p,{children:["\u01ac ",(0,t.jsx)(n.strong,{children:"GraphType"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">: ",(0,t.jsx)(n.code,{children:"AbstractGraph"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),"> | ",(0,t.jsx)(n.code,{children:"GraphConstructor"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-5",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/types.ts#L17",children:"packages/core/src/types.ts:17"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sigmacontainer",children:"SigmaContainer"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"SigmaContainer"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">(",(0,t.jsx)(n.code,{children:"props"}),"): ",(0,t.jsx)(n.code,{children:"ReactElement"}),"<",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"JSXElementConstructor"}),"<",(0,t.jsx)(n.code,{children:"any"}),">>"]}),"\n",(0,t.jsx)(n.h4,{id:"type-parameters-6",children:"Type parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"N"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"E"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"G"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsx)(n.tbody,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"props"})}),(0,t.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,t.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps",children:(0,t.jsx)(n.code,{children:"SigmaContainerProps"})}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),"> & { ",(0,t.jsx)(n.code,{children:"children?"}),": ",(0,t.jsx)(n.code,{children:"ReactNode"})," } & ",(0,t.jsx)(n.code,{children:"RefAttributes"}),"<",(0,t.jsx)(n.code,{children:"null"})," | ",(0,t.jsx)(n.code,{children:"default"}),"<",(0,t.jsx)(n.code,{children:"N"}),", ",(0,t.jsx)(n.code,{children:"E"}),", ",(0,t.jsx)(n.code,{children:"G"}),">>"]})]})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"ReactElement"}),"<",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"JSXElementConstructor"}),"<",(0,t.jsx)(n.code,{children:"any"}),">>"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/SigmaContainer.tsx#L141",children:"packages/core/src/components/SigmaContainer.tsx:141"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"getuniquekey",children:"getUniqueKey"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"getUniqueKey"}),"(): ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/utils.ts#L1",children:"packages/core/src/utils.ts:1"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"isequal",children:"isEqual"}),"\n",(0,t.jsxs)(n.p,{children:["\u25b8 ",(0,t.jsx)(n.strong,{children:"isEqual"}),"(",(0,t.jsx)(n.code,{children:"x"}),", ",(0,t.jsx)(n.code,{children:"y"}),"): ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n",(0,t.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,t.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"x"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"unknown"})})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"y"})}),(0,t.jsx)(n.td,{style:{textAlign:"left"},children:(0,t.jsx)(n.code,{children:"unknown"})})]})]})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/utils.ts#L5",children:"packages/core/src/utils.ts:5"})})]})}function x(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>d});var t=s(4041);const r={},l=t.createContext(r);function i(e){const n=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/32dd47bd.b28dcdae.js b/assets/js/32dd47bd.9511ae0b.js similarity index 93% rename from assets/js/32dd47bd.b28dcdae.js rename to assets/js/32dd47bd.9511ae0b.js index 0fbd91cf..19bbcc84 100644 --- a/assets/js/32dd47bd.b28dcdae.js +++ b/assets/js/32dd47bd.9511ae0b.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[765],{9243:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=r(1085),t=r(1184);const i={id:"SearchControlProps",title:"Interface: SearchControlProps",sidebar_label:"SearchControlProps",sidebar_position:0,custom_edit_url:null},o=void 0,c={id:"api/core/interfaces/SearchControlProps",title:"Interface: SearchControlProps",description:"Properties for SearchControl component",source:"@site/docs/api/core/interfaces/SearchControlProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SearchControlProps",title:"Interface: SearchControlProps",sidebar_label:"SearchControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps"},next:{title:"SigmaContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"SearchControl"})," component"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML class"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/SearchControl.tsx#L23",children:"packages/core/src/components/controls/SearchControl.tsx:23"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/SearchControl.tsx#L18",children:"packages/core/src/components/controls/SearchControl.tsx:18"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,s.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"placeholder"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"text"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/SearchControl.tsx#L34",children:"packages/core/src/components/controls/SearchControl.tsx:34"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/SearchControl.tsx#L28",children:"packages/core/src/components/controls/SearchControl.tsx:28"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var s=r(4041);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[765],{9243:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=r(1085),t=r(1184);const i={id:"SearchControlProps",title:"Interface: SearchControlProps",sidebar_label:"SearchControlProps",sidebar_position:0,custom_edit_url:null},o=void 0,c={id:"api/core/interfaces/SearchControlProps",title:"Interface: SearchControlProps",description:"Properties for SearchControl component",source:"@site/docs/api/core/interfaces/SearchControlProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SearchControlProps",title:"Interface: SearchControlProps",sidebar_label:"SearchControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps"},next:{title:"SigmaContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"SearchControl"})," component"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML class"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/SearchControl.tsx#L23",children:"packages/core/src/components/controls/SearchControl.tsx:23"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/SearchControl.tsx#L18",children:"packages/core/src/components/controls/SearchControl.tsx:18"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"Object"})]}),"\n",(0,s.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,s.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"placeholder"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"text"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/SearchControl.tsx#L34",children:"packages/core/src/components/controls/SearchControl.tsx:34"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/SearchControl.tsx#L28",children:"packages/core/src/components/controls/SearchControl.tsx:28"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var s=r(4041);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/47a287a0.4528757a.js b/assets/js/47a287a0.15c7666b.js similarity index 93% rename from assets/js/47a287a0.4528757a.js rename to assets/js/47a287a0.15c7666b.js index 4fd01c2f..563e65dd 100644 --- a/assets/js/47a287a0.4528757a.js +++ b/assets/js/47a287a0.15c7666b.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[146],{5542:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var l=r(1085),s=r(1184);const t={id:"FullScreenControlProps",title:"Interface: FullScreenControlProps",sidebar_label:"FullScreenControlProps",sidebar_position:0,custom_edit_url:null},i=void 0,c={id:"api/core/interfaces/FullScreenControlProps",title:"Interface: FullScreenControlProps",description:"Properties for FullScreenControl component.",source:"@site/docs/api/core/interfaces/FullScreenControlProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FullScreenControlProps",title:"Interface: FullScreenControlProps",sidebar_label:"FullScreenControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"},next:{title:"SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"container",id:"container",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsxs)(n.p,{children:["Properties for ",(0,l.jsx)(n.code,{children:"FullScreenControl"})," component."]}),"\n",(0,l.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,l.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"children"}),": [",(0,l.jsx)(n.code,{children:"Element"}),", ",(0,l.jsx)(n.code,{children:"Element"}),"]"]}),"\n",(0,l.jsx)(n.p,{children:'It\'s possible to customize the button, by passing to JSX Element.\nFirst one is for the "enter fullscreen", and the second to "exit fullscreen".\nExample :'}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-jsx",children:"\n \n \n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L44",children:"packages/core/src/components/controls/FullScreenControl.tsx:44"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"className"}),": ",(0,l.jsx)(n.code,{children:"string"})]}),"\n",(0,l.jsx)(n.p,{children:"HTML class"}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L21",children:"packages/core/src/components/controls/FullScreenControl.tsx:21"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"container",children:"container"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"container"}),": ",(0,l.jsx)(n.code,{children:"RefObject"}),"<",(0,l.jsx)(n.code,{children:"HTMLElement"}),">"]}),"\n",(0,l.jsx)(n.p,{children:"If defined, this container will be taken for the fullscreen instead of the sigma one."}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L31",children:"packages/core/src/components/controls/FullScreenControl.tsx:31"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"id"}),": ",(0,l.jsx)(n.code,{children:"string"})]}),"\n",(0,l.jsx)(n.p,{children:"HTML id"}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L16",children:"packages/core/src/components/controls/FullScreenControl.tsx:16"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"labels"}),": ",(0,l.jsx)(n.code,{children:"Object"})]}),"\n",(0,l.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,l.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"enter"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.code,{children:"string"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"exit"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L50",children:"packages/core/src/components/controls/FullScreenControl.tsx:50"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"style"}),": ",(0,l.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,l.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/FullScreenControl.tsx#L26",children:"packages/core/src/components/controls/FullScreenControl.tsx:26"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var l=r(4041);const s={},t=l.createContext(s);function i(e){const n=l.useContext(t);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[146],{5542:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var l=r(1085),s=r(1184);const t={id:"FullScreenControlProps",title:"Interface: FullScreenControlProps",sidebar_label:"FullScreenControlProps",sidebar_position:0,custom_edit_url:null},i=void 0,c={id:"api/core/interfaces/FullScreenControlProps",title:"Interface: FullScreenControlProps",description:"Properties for FullScreenControl component.",source:"@site/docs/api/core/interfaces/FullScreenControlProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FullScreenControlProps",title:"Interface: FullScreenControlProps",sidebar_label:"FullScreenControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"},next:{title:"SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"container",id:"container",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsxs)(n.p,{children:["Properties for ",(0,l.jsx)(n.code,{children:"FullScreenControl"})," component."]}),"\n",(0,l.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,l.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"children"}),": [",(0,l.jsx)(n.code,{children:"Element"}),", ",(0,l.jsx)(n.code,{children:"Element"}),"]"]}),"\n",(0,l.jsx)(n.p,{children:'It\'s possible to customize the button, by passing to JSX Element.\nFirst one is for the "enter fullscreen", and the second to "exit fullscreen".\nExample :'}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-jsx",children:"\n \n \n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L44",children:"packages/core/src/components/controls/FullScreenControl.tsx:44"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"className"}),": ",(0,l.jsx)(n.code,{children:"string"})]}),"\n",(0,l.jsx)(n.p,{children:"HTML class"}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L21",children:"packages/core/src/components/controls/FullScreenControl.tsx:21"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"container",children:"container"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"container"}),": ",(0,l.jsx)(n.code,{children:"RefObject"}),"<",(0,l.jsx)(n.code,{children:"HTMLElement"}),">"]}),"\n",(0,l.jsx)(n.p,{children:"If defined, this container will be taken for the fullscreen instead of the sigma one."}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L31",children:"packages/core/src/components/controls/FullScreenControl.tsx:31"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"id"}),": ",(0,l.jsx)(n.code,{children:"string"})]}),"\n",(0,l.jsx)(n.p,{children:"HTML id"}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L16",children:"packages/core/src/components/controls/FullScreenControl.tsx:16"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"labels"}),": ",(0,l.jsx)(n.code,{children:"Object"})]}),"\n",(0,l.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,l.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"enter"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.code,{children:"string"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"exit"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"undefined"})," | ",(0,l.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L50",children:"packages/core/src/components/controls/FullScreenControl.tsx:50"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,l.jsxs)(n.p,{children:["\u2022 ",(0,l.jsx)(n.code,{children:"Optional"})," ",(0,l.jsx)(n.strong,{children:"style"}),": ",(0,l.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,l.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/FullScreenControl.tsx#L26",children:"packages/core/src/components/controls/FullScreenControl.tsx:26"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>c});var l=r(4041);const s={},t=l.createContext(s);function i(e){const n=l.useContext(t);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6c3cbc8a.3d21f077.js b/assets/js/6c3cbc8a.028f37fb.js similarity index 97% rename from assets/js/6c3cbc8a.3d21f077.js rename to assets/js/6c3cbc8a.028f37fb.js index 1e200de6..6c641f66 100644 --- a/assets/js/6c3cbc8a.3d21f077.js +++ b/assets/js/6c3cbc8a.028f37fb.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[16],{3656:(e,t,l)=>{l.r(t),l.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>a});var r=l(1085),n=l(1184);const s={id:"index",title:"@react-sigma/layout-noverlap",sidebar_label:"layout-noverlap",sidebar_position:.5,custom_edit_url:null},o=void 0,i={id:"api/layout-noverlap/index",title:"@react-sigma/layout-noverlap",description:"Component",source:"@site/docs/api/layout-noverlap/index.md",sourceDirName:"api/layout-noverlap",slug:"/api/layout-noverlap/",permalink:"/react-sigma/docs/api/layout-noverlap/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-noverlap",sidebar_label:"layout-noverlap",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-force",permalink:"/react-sigma/docs/api/layout-force/"},next:{title:"Load a graph",permalink:"/react-sigma/docs/example/load-graph"}},d={},a=[{value:"Component",id:"component",level:2},{value:"LayoutNoverlapControl",id:"layoutnoverlapcontrol",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Hook",id:"hook",level:2},{value:"useLayoutNoverlap",id:"uselayoutnoverlap",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useWorkerLayoutNoverlap",id:"useworkerlayoutnoverlap",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Other",id:"other",level:2},{value:"LayoutNoverlapControlProps",id:"layoutnoverlapcontrolprops",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function c(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"component",children:"Component"}),"\n",(0,r.jsx)(t.h3,{id:"layoutnoverlapcontrol",children:"LayoutNoverlapControl"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"LayoutNoverlapControl"}),"(",(0,r.jsx)(t.code,{children:"props"}),", ",(0,r.jsx)(t.code,{children:"context?"}),"): ",(0,r.jsx)(t.code,{children:"ReactNode"})]}),"\n",(0,r.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"props"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.a,{href:"#layoutnoverlapcontrolprops",children:(0,r.jsx)(t.code,{children:"LayoutNoverlapControlProps"})})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"context?"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"any"})})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"ReactNode"})}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L20",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20"})}),"\n",(0,r.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,r.jsx)(t.h3,{id:"uselayoutnoverlap",children:"useLayoutNoverlap"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"useLayoutNoverlap"}),"(",(0,r.jsx)(t.code,{children:"settings?"}),"): ",(0,r.jsx)(t.code,{children:"Object"})]}),"\n",(0,r.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,r.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutNoverlap(...);\n"})}),"\n",(0,r.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"settings?"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"NoverlapLayoutParameters"})})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"Object"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"assign"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"positions"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,r.jsx)(t.code,{children:"[node: string]"}),": { ",(0,r.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,r.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-noverlap/src/useLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useLayoutNoverlap.ts:13"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"useworkerlayoutnoverlap",children:"useWorkerLayoutNoverlap"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"useWorkerLayoutNoverlap"}),"(",(0,r.jsx)(t.code,{children:"settings"}),"): ",(0,r.jsx)(t.code,{children:"Object"})]}),"\n",(0,r.jsxs)(t.p,{children:["React hook that helps you to manage worker for ",(0,r.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutNoverlap({layoutOptions});\n"})}),"\n",(0,r.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"settings"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"NoverlapLayoutSupervisorParameters"})})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"Object"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"isRunning"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"boolean"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"kill"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"start"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"stop"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13"})}),"\n",(0,r.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,r.jsx)(t.h3,{id:"layoutnoverlapcontrolprops",children:"LayoutNoverlapControlProps"}),"\n",(0,r.jsxs)(t.p,{children:["\u01ac ",(0,r.jsx)(t.strong,{children:"LayoutNoverlapControlProps"}),": ",(0,r.jsx)(t.code,{children:"Omit"}),"<",(0,r.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,r.jsx)(t.code,{children:"NoverlapLayoutSupervisorParameters"}),">, ",(0,r.jsx)(t.code,{children:'"layout"'})," | ",(0,r.jsx)(t.code,{children:'"settings"'}),"> & { ",(0,r.jsx)(t.code,{children:"settings?"}),": ",(0,r.jsx)(t.code,{children:"NoverlapLayoutSupervisorParameters"})," }"]}),"\n",(0,r.jsxs)(t.p,{children:["Properties for ",(0,r.jsx)(t.code,{children:"NoverlapControl"})," component"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L10",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:10"})})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},1184:(e,t,l)=>{l.d(t,{R:()=>o,x:()=>i});var r=l(4041);const n={},s=r.createContext(n);function o(e){const t=r.useContext(s);return r.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(n):e.components||n:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[16],{3656:(e,t,l)=>{l.r(t),l.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>a});var r=l(1085),n=l(1184);const s={id:"index",title:"@react-sigma/layout-noverlap",sidebar_label:"layout-noverlap",sidebar_position:.5,custom_edit_url:null},o=void 0,i={id:"api/layout-noverlap/index",title:"@react-sigma/layout-noverlap",description:"Component",source:"@site/docs/api/layout-noverlap/index.md",sourceDirName:"api/layout-noverlap",slug:"/api/layout-noverlap/",permalink:"/react-sigma/docs/api/layout-noverlap/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-noverlap",sidebar_label:"layout-noverlap",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-force",permalink:"/react-sigma/docs/api/layout-force/"},next:{title:"Load a graph",permalink:"/react-sigma/docs/example/load-graph"}},d={},a=[{value:"Component",id:"component",level:2},{value:"LayoutNoverlapControl",id:"layoutnoverlapcontrol",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Hook",id:"hook",level:2},{value:"useLayoutNoverlap",id:"uselayoutnoverlap",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useWorkerLayoutNoverlap",id:"useworkerlayoutnoverlap",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Other",id:"other",level:2},{value:"LayoutNoverlapControlProps",id:"layoutnoverlapcontrolprops",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function c(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"component",children:"Component"}),"\n",(0,r.jsx)(t.h3,{id:"layoutnoverlapcontrol",children:"LayoutNoverlapControl"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"LayoutNoverlapControl"}),"(",(0,r.jsx)(t.code,{children:"props"}),", ",(0,r.jsx)(t.code,{children:"context?"}),"): ",(0,r.jsx)(t.code,{children:"ReactNode"})]}),"\n",(0,r.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"props"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.a,{href:"#layoutnoverlapcontrolprops",children:(0,r.jsx)(t.code,{children:"LayoutNoverlapControlProps"})})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"context?"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"any"})})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"ReactNode"})}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L20",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20"})}),"\n",(0,r.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,r.jsx)(t.h3,{id:"uselayoutnoverlap",children:"useLayoutNoverlap"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"useLayoutNoverlap"}),"(",(0,r.jsx)(t.code,{children:"settings?"}),"): ",(0,r.jsx)(t.code,{children:"Object"})]}),"\n",(0,r.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,r.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutNoverlap(...);\n"})}),"\n",(0,r.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"settings?"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"NoverlapLayoutParameters"})})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"Object"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"assign"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"positions"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,r.jsx)(t.code,{children:"[node: string]"}),": { ",(0,r.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,r.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-noverlap/src/useLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useLayoutNoverlap.ts:13"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"useworkerlayoutnoverlap",children:"useWorkerLayoutNoverlap"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"useWorkerLayoutNoverlap"}),"(",(0,r.jsx)(t.code,{children:"settings"}),"): ",(0,r.jsx)(t.code,{children:"Object"})]}),"\n",(0,r.jsxs)(t.p,{children:["React hook that helps you to manage worker for ",(0,r.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutNoverlap({layoutOptions});\n"})}),"\n",(0,r.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"settings"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"NoverlapLayoutSupervisorParameters"})})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"Object"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"isRunning"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"boolean"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"kill"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"start"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"stop"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,r.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13"})}),"\n",(0,r.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,r.jsx)(t.h3,{id:"layoutnoverlapcontrolprops",children:"LayoutNoverlapControlProps"}),"\n",(0,r.jsxs)(t.p,{children:["\u01ac ",(0,r.jsx)(t.strong,{children:"LayoutNoverlapControlProps"}),": ",(0,r.jsx)(t.code,{children:"Omit"}),"<",(0,r.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,r.jsx)(t.code,{children:"NoverlapLayoutSupervisorParameters"}),">, ",(0,r.jsx)(t.code,{children:'"layout"'})," | ",(0,r.jsx)(t.code,{children:'"settings"'}),"> & { ",(0,r.jsx)(t.code,{children:"settings?"}),": ",(0,r.jsx)(t.code,{children:"NoverlapLayoutSupervisorParameters"})," }"]}),"\n",(0,r.jsxs)(t.p,{children:["Properties for ",(0,r.jsx)(t.code,{children:"NoverlapControl"})," component"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L10",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:10"})})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},1184:(e,t,l)=>{l.d(t,{R:()=>o,x:()=>i});var r=l(4041);const n={},s=r.createContext(n);function o(e){const t=r.useContext(s);return r.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(n):e.components||n:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/958d1a80.27e67060.js b/assets/js/958d1a80.e26b9d10.js similarity index 98% rename from assets/js/958d1a80.27e67060.js rename to assets/js/958d1a80.e26b9d10.js index 57af41ff..35fd3eec 100644 --- a/assets/js/958d1a80.27e67060.js +++ b/assets/js/958d1a80.e26b9d10.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[459],{5284:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>n,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=r(1085),l=r(1184);const s={id:"index",title:"@react-sigma/layout-circular",sidebar_label:"layout-circular",sidebar_position:.5,custom_edit_url:null},n=void 0,c={id:"api/layout-circular/index",title:"@react-sigma/layout-circular",description:"Hook",source:"@site/docs/api/layout-circular/index.md",sourceDirName:"api/layout-circular",slug:"/api/layout-circular/",permalink:"/react-sigma/docs/api/layout-circular/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-circular",sidebar_label:"layout-circular",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-random",permalink:"/react-sigma/docs/api/layout-random/"},next:{title:"layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"}},a={},d=[{value:"Hook",id:"hook",level:2},{value:"useLayoutCircular",id:"uselayoutcircular",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,i.jsx)(t.h3,{id:"uselayoutcircular",children:"useLayoutCircular"}),"\n",(0,i.jsxs)(t.p,{children:["\u25b8 ",(0,i.jsx)(t.strong,{children:"useLayoutCircular"}),"(",(0,i.jsx)(t.code,{children:"settings?"}),"): ",(0,i.jsx)(t.code,{children:"Object"})]}),"\n",(0,i.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,i.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout.html#circular",children:"circle layout"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCircular(...);\n"})}),"\n",(0,i.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"settings?"})}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"CircularLayoutOptions"})})]})})]}),"\n",(0,i.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"Object"})}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"assign"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,i.jsx)(t.code,{children:"void"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"positions"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,i.jsx)(t.code,{children:"[node: string]"}),": { ",(0,i.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,i.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-circular/src/useLayoutCircular.ts#L13",children:"layout-circular/src/useLayoutCircular.ts:13"})})]})}function u(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>n,x:()=>c});var i=r(4041);const l={},s=i.createContext(l);function n(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:n(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[459],{5284:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>n,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=r(1085),l=r(1184);const s={id:"index",title:"@react-sigma/layout-circular",sidebar_label:"layout-circular",sidebar_position:.5,custom_edit_url:null},n=void 0,c={id:"api/layout-circular/index",title:"@react-sigma/layout-circular",description:"Hook",source:"@site/docs/api/layout-circular/index.md",sourceDirName:"api/layout-circular",slug:"/api/layout-circular/",permalink:"/react-sigma/docs/api/layout-circular/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-circular",sidebar_label:"layout-circular",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-random",permalink:"/react-sigma/docs/api/layout-random/"},next:{title:"layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"}},a={},d=[{value:"Hook",id:"hook",level:2},{value:"useLayoutCircular",id:"uselayoutcircular",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,i.jsx)(t.h3,{id:"uselayoutcircular",children:"useLayoutCircular"}),"\n",(0,i.jsxs)(t.p,{children:["\u25b8 ",(0,i.jsx)(t.strong,{children:"useLayoutCircular"}),"(",(0,i.jsx)(t.code,{children:"settings?"}),"): ",(0,i.jsx)(t.code,{children:"Object"})]}),"\n",(0,i.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,i.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout.html#circular",children:"circle layout"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCircular(...);\n"})}),"\n",(0,i.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"settings?"})}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"CircularLayoutOptions"})})]})})]}),"\n",(0,i.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"Object"})}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"assign"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,i.jsx)(t.code,{children:"void"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"positions"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,i.jsx)(t.code,{children:"[node: string]"}),": { ",(0,i.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,i.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-circular/src/useLayoutCircular.ts#L13",children:"layout-circular/src/useLayoutCircular.ts:13"})})]})}function u(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>n,x:()=>c});var i=r(4041);const l={},s=i.createContext(l);function n(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:n(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/999d5064.e9c61496.js b/assets/js/999d5064.67382351.js similarity index 94% rename from assets/js/999d5064.e9c61496.js rename to assets/js/999d5064.67382351.js index d4e42153..07d7b437 100644 --- a/assets/js/999d5064.e9c61496.js +++ b/assets/js/999d5064.67382351.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[799],{3584:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var s=i(1085),t=i(1184);const r={id:"SigmaContainerProps",title:"Interface: SigmaContainerProps",sidebar_label:"SigmaContainerProps",sidebar_position:0,custom_edit_url:null},c=void 0,d={id:"api/core/interfaces/SigmaContainerProps",title:"Interface: SigmaContainerProps",description:"Properties for SigmaContainer component",source:"@site/docs/api/core/interfaces/SigmaContainerProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/SigmaContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SigmaContainerProps",title:"Interface: SigmaContainerProps",sidebar_label:"SigmaContainerProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"},next:{title:"SigmaContextInterface",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"}},a={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"graph",id:"graph",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"SigmaContainer"})," component"]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"N"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.code,{children:"Attributes"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"E"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.code,{children:"Attributes"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"G"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML class"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/SigmaContainer.tsx#L41",children:"packages/core/src/components/SigmaContainer.tsx:41"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"graph",children:"graph"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"graph"}),": ",(0,s.jsx)(n.a,{href:"../#graphtype",children:(0,s.jsx)(n.code,{children:"GraphType"})}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Graphology instance or constructor"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/SigmaContainer.tsx#L29",children:"packages/core/src/components/SigmaContainer.tsx:29"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/SigmaContainer.tsx#L37",children:"packages/core/src/components/SigmaContainer.tsx:37"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"settings"}),": ",(0,s.jsx)(n.code,{children:"Partial"}),"<",(0,s.jsx)(n.code,{children:"Settings"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">>"]}),"\n",(0,s.jsx)(n.p,{children:"Sigma settings"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/SigmaContainer.tsx#L33",children:"packages/core/src/components/SigmaContainer.tsx:33"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/SigmaContainer.tsx#L45",children:"packages/core/src/components/SigmaContainer.tsx:45"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1184:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var s=i(4041);const t={},r=s.createContext(t);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[799],{3584:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var s=i(1085),t=i(1184);const r={id:"SigmaContainerProps",title:"Interface: SigmaContainerProps",sidebar_label:"SigmaContainerProps",sidebar_position:0,custom_edit_url:null},c=void 0,d={id:"api/core/interfaces/SigmaContainerProps",title:"Interface: SigmaContainerProps",description:"Properties for SigmaContainer component",source:"@site/docs/api/core/interfaces/SigmaContainerProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/SigmaContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SigmaContainerProps",title:"Interface: SigmaContainerProps",sidebar_label:"SigmaContainerProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"},next:{title:"SigmaContextInterface",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"}},a={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"graph",id:"graph",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"SigmaContainer"})," component"]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"N"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.code,{children:"Attributes"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"E"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.code,{children:"Attributes"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"G"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.code,{children:"Attributes"})]})]})]})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML class"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/SigmaContainer.tsx#L41",children:"packages/core/src/components/SigmaContainer.tsx:41"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"graph",children:"graph"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"graph"}),": ",(0,s.jsx)(n.a,{href:"../#graphtype",children:(0,s.jsx)(n.code,{children:"GraphType"})}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Graphology instance or constructor"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/SigmaContainer.tsx#L29",children:"packages/core/src/components/SigmaContainer.tsx:29"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/SigmaContainer.tsx#L37",children:"packages/core/src/components/SigmaContainer.tsx:37"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"settings"}),": ",(0,s.jsx)(n.code,{children:"Partial"}),"<",(0,s.jsx)(n.code,{children:"Settings"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">>"]}),"\n",(0,s.jsx)(n.p,{children:"Sigma settings"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/SigmaContainer.tsx#L33",children:"packages/core/src/components/SigmaContainer.tsx:33"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/SigmaContainer.tsx#L45",children:"packages/core/src/components/SigmaContainer.tsx:45"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1184:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var s=i(4041);const t={},r=s.createContext(t);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2f529ce.e3db937d.js b/assets/js/a2f529ce.1bec4d80.js similarity index 97% rename from assets/js/a2f529ce.e3db937d.js rename to assets/js/a2f529ce.1bec4d80.js index efe3b030..e1752000 100644 --- a/assets/js/a2f529ce.e3db937d.js +++ b/assets/js/a2f529ce.1bec4d80.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[770],{9759:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>n,metadata:()=>i,toc:()=>a});var l=s(1085),r=s(1184);const n={id:"index",title:"@react-sigma/layout-forceatlas2",sidebar_label:"layout-forceatlas2",sidebar_position:.5,custom_edit_url:null},o=void 0,i={id:"api/layout-forceatlas2/index",title:"@react-sigma/layout-forceatlas2",description:"Component",source:"@site/docs/api/layout-forceatlas2/index.md",sourceDirName:"api/layout-forceatlas2",slug:"/api/layout-forceatlas2/",permalink:"/react-sigma/docs/api/layout-forceatlas2/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-forceatlas2",sidebar_label:"layout-forceatlas2",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"},next:{title:"layout-force",permalink:"/react-sigma/docs/api/layout-force/"}},c={},a=[{value:"Component",id:"component",level:2},{value:"LayoutForceAtlas2Control",id:"layoutforceatlas2control",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Hook",id:"hook",level:2},{value:"useLayoutForceAtlas2",id:"uselayoutforceatlas2",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useWorkerLayoutForceAtlas2",id:"useworkerlayoutforceatlas2",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Other",id:"other",level:2},{value:"LayoutForceAtlas2ControlProps",id:"layoutforceatlas2controlprops",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.h2,{id:"component",children:"Component"}),"\n",(0,l.jsx)(t.h3,{id:"layoutforceatlas2control",children:"LayoutForceAtlas2Control"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"LayoutForceAtlas2Control"}),"(",(0,l.jsx)(t.code,{children:"props"}),", ",(0,l.jsx)(t.code,{children:"context?"}),"): ",(0,l.jsx)(t.code,{children:"ReactNode"})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"props"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.a,{href:"#layoutforceatlas2controlprops",children:(0,l.jsx)(t.code,{children:"LayoutForceAtlas2ControlProps"})})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"context?"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"any"})})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"ReactNode"})}),"\n",(0,l.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L20",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20"})}),"\n",(0,l.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,l.jsx)(t.h3,{id:"uselayoutforceatlas2",children:"useLayoutForceAtlas2"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useLayoutForceAtlas2"}),"(",(0,l.jsx)(t.code,{children:"settings?"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,l.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForceAtlas2(...);\n"})}),"\n",(0,l.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings?"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.code,{children:"ForceAtlas2SynchronousLayoutParameters"}),"<",(0,l.jsx)(t.code,{children:"Attributes"}),", ",(0,l.jsx)(t.code,{children:"Attributes"}),">"]})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"assign"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"positions"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,l.jsx)(t.code,{children:"[node: string]"}),": { ",(0,l.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,l.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts#L13",children:"packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"useworkerlayoutforceatlas2",children:"useWorkerLayoutForceAtlas2"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useWorkerLayoutForceAtlas2"}),"(",(0,l.jsx)(t.code,{children:"settings"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsxs)(t.p,{children:["React hook that helps you to manage worker of ",(0,l.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForceAtlas2(...);\n"})}),"\n",(0,l.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"})})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"isRunning"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"boolean"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"kill"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"start"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"stop"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts#L14",children:"packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14"})}),"\n",(0,l.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,l.jsx)(t.h3,{id:"layoutforceatlas2controlprops",children:"LayoutForceAtlas2ControlProps"}),"\n",(0,l.jsxs)(t.p,{children:["\u01ac ",(0,l.jsx)(t.strong,{children:"LayoutForceAtlas2ControlProps"}),": ",(0,l.jsx)(t.code,{children:"Omit"}),"<",(0,l.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,l.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"}),">, ",(0,l.jsx)(t.code,{children:'"layout"'})," | ",(0,l.jsx)(t.code,{children:'"settings"'}),"> & { ",(0,l.jsx)(t.code,{children:"settings?"}),": ",(0,l.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"})," }"]}),"\n",(0,l.jsxs)(t.p,{children:["Properties for ",(0,l.jsx)(t.code,{children:"LayoutForceAtlas2Control"})," component"]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L10",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>i});var l=s(4041);const r={},n=l.createContext(r);function o(e){const t=l.useContext(n);return l.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(r):e.components||r:o(e.components),l.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[770],{9759:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>n,metadata:()=>i,toc:()=>a});var l=s(1085),r=s(1184);const n={id:"index",title:"@react-sigma/layout-forceatlas2",sidebar_label:"layout-forceatlas2",sidebar_position:.5,custom_edit_url:null},o=void 0,i={id:"api/layout-forceatlas2/index",title:"@react-sigma/layout-forceatlas2",description:"Component",source:"@site/docs/api/layout-forceatlas2/index.md",sourceDirName:"api/layout-forceatlas2",slug:"/api/layout-forceatlas2/",permalink:"/react-sigma/docs/api/layout-forceatlas2/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-forceatlas2",sidebar_label:"layout-forceatlas2",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"},next:{title:"layout-force",permalink:"/react-sigma/docs/api/layout-force/"}},c={},a=[{value:"Component",id:"component",level:2},{value:"LayoutForceAtlas2Control",id:"layoutforceatlas2control",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Hook",id:"hook",level:2},{value:"useLayoutForceAtlas2",id:"uselayoutforceatlas2",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useWorkerLayoutForceAtlas2",id:"useworkerlayoutforceatlas2",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Other",id:"other",level:2},{value:"LayoutForceAtlas2ControlProps",id:"layoutforceatlas2controlprops",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.h2,{id:"component",children:"Component"}),"\n",(0,l.jsx)(t.h3,{id:"layoutforceatlas2control",children:"LayoutForceAtlas2Control"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"LayoutForceAtlas2Control"}),"(",(0,l.jsx)(t.code,{children:"props"}),", ",(0,l.jsx)(t.code,{children:"context?"}),"): ",(0,l.jsx)(t.code,{children:"ReactNode"})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"props"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.a,{href:"#layoutforceatlas2controlprops",children:(0,l.jsx)(t.code,{children:"LayoutForceAtlas2ControlProps"})})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"context?"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"any"})})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"ReactNode"})}),"\n",(0,l.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L20",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20"})}),"\n",(0,l.jsx)(t.h2,{id:"hook",children:"Hook"}),"\n",(0,l.jsx)(t.h3,{id:"uselayoutforceatlas2",children:"useLayoutForceAtlas2"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useLayoutForceAtlas2"}),"(",(0,l.jsx)(t.code,{children:"settings?"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsxs)(t.p,{children:["React hook that helps you to manage ",(0,l.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForceAtlas2(...);\n"})}),"\n",(0,l.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings?"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.code,{children:"ForceAtlas2SynchronousLayoutParameters"}),"<",(0,l.jsx)(t.code,{children:"Attributes"}),", ",(0,l.jsx)(t.code,{children:"Attributes"}),">"]})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"assign"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"positions"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,l.jsx)(t.code,{children:"[node: string]"}),": { ",(0,l.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,l.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts#L13",children:"packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"useworkerlayoutforceatlas2",children:"useWorkerLayoutForceAtlas2"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useWorkerLayoutForceAtlas2"}),"(",(0,l.jsx)(t.code,{children:"settings"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsxs)(t.p,{children:["React hook that helps you to manage worker of ",(0,l.jsx)(t.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForceAtlas2(...);\n"})}),"\n",(0,l.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"})})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"isRunning"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"boolean"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"kill"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"start"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"stop"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts#L14",children:"packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14"})}),"\n",(0,l.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,l.jsx)(t.h3,{id:"layoutforceatlas2controlprops",children:"LayoutForceAtlas2ControlProps"}),"\n",(0,l.jsxs)(t.p,{children:["\u01ac ",(0,l.jsx)(t.strong,{children:"LayoutForceAtlas2ControlProps"}),": ",(0,l.jsx)(t.code,{children:"Omit"}),"<",(0,l.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,l.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"}),">, ",(0,l.jsx)(t.code,{children:'"layout"'})," | ",(0,l.jsx)(t.code,{children:'"settings"'}),"> & { ",(0,l.jsx)(t.code,{children:"settings?"}),": ",(0,l.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"})," }"]}),"\n",(0,l.jsxs)(t.p,{children:["Properties for ",(0,l.jsx)(t.code,{children:"LayoutForceAtlas2Control"})," component"]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L10",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>i});var l=s(4041);const r={},n=l.createContext(r);function o(e){const t=l.useContext(n);return l.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(r):e.components||r:o(e.components),l.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/de170a46.3b571217.js b/assets/js/de170a46.de9f4eaa.js similarity index 97% rename from assets/js/de170a46.3b571217.js rename to assets/js/de170a46.de9f4eaa.js index 88e15b77..5d5f0064 100644 --- a/assets/js/de170a46.3b571217.js +++ b/assets/js/de170a46.de9f4eaa.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[653],{4489:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var i=n(1085),r=n(1184);const s={id:"SigmaContextInterface",title:"Interface: SigmaContextInterface",sidebar_label:"SigmaContextInterface",sidebar_position:0,custom_edit_url:null},c=void 0,o={id:"api/core/interfaces/SigmaContextInterface",title:"Interface: SigmaContextInterface",description:"Type parameters",source:"@site/docs/api/core/interfaces/SigmaContextInterface.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/SigmaContextInterface",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SigmaContextInterface",title:"Interface: SigmaContextInterface",sidebar_label:"SigmaContextInterface",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"SigmaContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps"},next:{title:"ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps"}},a={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"container",id:"container",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"sigma",id:"sigma",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"N"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["extends ",(0,i.jsx)(t.code,{children:"Attributes"})," = ",(0,i.jsx)(t.code,{children:"Attributes"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"E"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["extends ",(0,i.jsx)(t.code,{children:"Attributes"})," = ",(0,i.jsx)(t.code,{children:"Attributes"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"G"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["extends ",(0,i.jsx)(t.code,{children:"Attributes"})," = ",(0,i.jsx)(t.code,{children:"Attributes"})]})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"container",children:"container"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"container"}),": ",(0,i.jsx)(t.code,{children:"HTMLElement"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/context.ts#L11",children:"packages/core/src/hooks/context.ts:11"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"sigma",children:"sigma"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"sigma"}),": ",(0,i.jsx)(t.code,{children:"default"}),"<",(0,i.jsx)(t.code,{children:"N"}),", ",(0,i.jsx)(t.code,{children:"E"}),", ",(0,i.jsx)(t.code,{children:"G"}),">"]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/hooks/context.ts#L10",children:"packages/core/src/hooks/context.ts:10"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var i=n(4041);const r={},s=i.createContext(r);function c(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[653],{4489:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var i=n(1085),r=n(1184);const s={id:"SigmaContextInterface",title:"Interface: SigmaContextInterface",sidebar_label:"SigmaContextInterface",sidebar_position:0,custom_edit_url:null},c=void 0,o={id:"api/core/interfaces/SigmaContextInterface",title:"Interface: SigmaContextInterface",description:"Type parameters",source:"@site/docs/api/core/interfaces/SigmaContextInterface.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/SigmaContextInterface",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SigmaContextInterface",title:"Interface: SigmaContextInterface",sidebar_label:"SigmaContextInterface",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"SigmaContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps"},next:{title:"ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps"}},a={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"container",id:"container",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"sigma",id:"sigma",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"N"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["extends ",(0,i.jsx)(t.code,{children:"Attributes"})," = ",(0,i.jsx)(t.code,{children:"Attributes"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"E"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["extends ",(0,i.jsx)(t.code,{children:"Attributes"})," = ",(0,i.jsx)(t.code,{children:"Attributes"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"G"})}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:["extends ",(0,i.jsx)(t.code,{children:"Attributes"})," = ",(0,i.jsx)(t.code,{children:"Attributes"})]})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"container",children:"container"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"container"}),": ",(0,i.jsx)(t.code,{children:"HTMLElement"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/context.ts#L11",children:"packages/core/src/hooks/context.ts:11"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"sigma",children:"sigma"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"sigma"}),": ",(0,i.jsx)(t.code,{children:"default"}),"<",(0,i.jsx)(t.code,{children:"N"}),", ",(0,i.jsx)(t.code,{children:"E"}),", ",(0,i.jsx)(t.code,{children:"G"}),">"]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/hooks/context.ts#L10",children:"packages/core/src/hooks/context.ts:10"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var i=n(4041);const r={},s=i.createContext(r);function c(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e82272c9.9833b66b.js b/assets/js/e82272c9.f0384b12.js similarity index 93% rename from assets/js/e82272c9.9833b66b.js rename to assets/js/e82272c9.f0384b12.js index 0fb9557a..9a59ffbe 100644 --- a/assets/js/e82272c9.9833b66b.js +++ b/assets/js/e82272c9.f0384b12.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[519],{5711:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=o(1085),r=o(1184);const i={id:"ControlsContainerProps",title:"Interface: ControlsContainerProps",sidebar_label:"ControlsContainerProps",sidebar_position:0,custom_edit_url:null},t=void 0,c={id:"api/core/interfaces/ControlsContainerProps",title:"Interface: ControlsContainerProps",description:"Properties for ControlsContainer component.",source:"@site/docs/api/core/interfaces/ControlsContainerProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ControlsContainerProps",title:"Interface: ControlsContainerProps",sidebar_label:"ControlsContainerProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"core",permalink:"/react-sigma/docs/api/core/"},next:{title:"FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"position",id:"position",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"ControlsContainer"})," component."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": ",(0,s.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ControlsContainer.tsx#L26",children:"packages/core/src/components/controls/ControlsContainer.tsx:26"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML class"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ControlsContainer.tsx#L14",children:"packages/core/src/components/controls/ControlsContainer.tsx:14"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ControlsContainer.tsx#L10",children:"packages/core/src/components/controls/ControlsContainer.tsx:10"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"position",children:"position"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"position"}),": ",(0,s.jsx)(n.code,{children:'"top-right"'})," | ",(0,s.jsx)(n.code,{children:'"top-left"'})," | ",(0,s.jsx)(n.code,{children:'"bottom-right"'})," | ",(0,s.jsx)(n.code,{children:'"bottom-left"'})]}),"\n",(0,s.jsx)(n.p,{children:"Position of the container"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ControlsContainer.tsx#L22",children:"packages/core/src/components/controls/ControlsContainer.tsx:22"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/core/src/components/controls/ControlsContainer.tsx#L18",children:"packages/core/src/components/controls/ControlsContainer.tsx:18"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1184:(e,n,o)=>{o.d(n,{R:()=>t,x:()=>c});var s=o(4041);const r={},i=s.createContext(r);function t(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[519],{5711:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=o(1085),r=o(1184);const i={id:"ControlsContainerProps",title:"Interface: ControlsContainerProps",sidebar_label:"ControlsContainerProps",sidebar_position:0,custom_edit_url:null},t=void 0,c={id:"api/core/interfaces/ControlsContainerProps",title:"Interface: ControlsContainerProps",description:"Properties for ControlsContainer component.",source:"@site/docs/api/core/interfaces/ControlsContainerProps.md",sourceDirName:"api/core/interfaces",slug:"/api/core/interfaces/ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ControlsContainerProps",title:"Interface: ControlsContainerProps",sidebar_label:"ControlsContainerProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"core",permalink:"/react-sigma/docs/api/core/"},next:{title:"FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"position",id:"position",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"ControlsContainer"})," component."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": ",(0,s.jsx)(n.code,{children:"ReactNode"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ControlsContainer.tsx#L26",children:"packages/core/src/components/controls/ControlsContainer.tsx:26"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML class"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ControlsContainer.tsx#L14",children:"packages/core/src/components/controls/ControlsContainer.tsx:14"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ControlsContainer.tsx#L10",children:"packages/core/src/components/controls/ControlsContainer.tsx:10"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"position",children:"position"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"position"}),": ",(0,s.jsx)(n.code,{children:'"top-right"'})," | ",(0,s.jsx)(n.code,{children:'"top-left"'})," | ",(0,s.jsx)(n.code,{children:'"bottom-right"'})," | ",(0,s.jsx)(n.code,{children:'"bottom-left"'})]}),"\n",(0,s.jsx)(n.p,{children:"Position of the container"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ControlsContainer.tsx#L22",children:"packages/core/src/components/controls/ControlsContainer.tsx:22"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/core/src/components/controls/ControlsContainer.tsx#L18",children:"packages/core/src/components/controls/ControlsContainer.tsx:18"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1184:(e,n,o)=>{o.d(n,{R:()=>t,x:()=>c});var s=o(4041);const r={},i=s.createContext(r);function t(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9d20596.64ebd800.js b/assets/js/e9d20596.8b41f9f9.js similarity index 94% rename from assets/js/e9d20596.64ebd800.js rename to assets/js/e9d20596.8b41f9f9.js index 993e9435..2ed28d1a 100644 --- a/assets/js/e9d20596.64ebd800.js +++ b/assets/js/e9d20596.8b41f9f9.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[379],{5682:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var r=t(1085),s=t(1184);const i={id:"WorkerLayoutControlProps",title:"Interface: WorkerLayoutControlProps",sidebar_label:"WorkerLayoutControlProps",sidebar_position:0,custom_edit_url:null},o=void 0,l={id:"api/layout-core/interfaces/WorkerLayoutControlProps",title:"Interface: WorkerLayoutControlProps",description:"Properties for WorkerLayoutControl component",source:"@site/docs/api/layout-core/interfaces/WorkerLayoutControlProps.md",sourceDirName:"api/layout-core/interfaces",slug:"/api/layout-core/interfaces/WorkerLayoutControlProps",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"WorkerLayoutControlProps",title:"Interface: WorkerLayoutControlProps",sidebar_label:"WorkerLayoutControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-core",permalink:"/react-sigma/docs/api/layout-core/"},next:{title:"layout-random",permalink:"/react-sigma/docs/api/layout-random/"}},d={},a=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"autoRunFor",id:"autorunfor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"layout",id:"layout",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["Properties for ",(0,r.jsx)(n.code,{children:"WorkerLayoutControl"})," component"]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"autorunfor",children:"autoRunFor"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"autoRunFor"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Option to tell what we do when the component is mounted"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)("code",{children:"-1"})," means that we do nothing (it's the same as no value)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)("code",{children:"0"})," means that we start the algo (and don't auto stop it)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)("code",{children:"X"})," mans that we start the algo, and stop it after X milliseconds"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L45",children:"WorkerLayoutControl.tsx:45"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"children"}),": [",(0,r.jsx)(n.code,{children:"Element"}),", ",(0,r.jsx)(n.code,{children:"Element"}),"]"]}),"\n",(0,r.jsx)(n.p,{children:'It\'s possible to customize the button, by passing to JSX Element.\nFirst one is for the "start layout", and the second to "stop layout".\nExample :'}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-jsx",children:"\n <>\n Start\n Stop\n \n\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L60",children:"WorkerLayoutControl.tsx:60"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"className"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"HTML class"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L22",children:"WorkerLayoutControl.tsx:22"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"HTML id"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L17",children:"WorkerLayoutControl.tsx:17"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"labels"}),": ",(0,r.jsx)(n.code,{children:"Object"})]}),"\n",(0,r.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,r.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"start"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"stop"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L66",children:"WorkerLayoutControl.tsx:66"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"layout",children:"layout"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"layout"}),": ",(0,r.jsx)(n.a,{href:"../#layoutworkerhook",children:(0,r.jsx)(n.code,{children:"LayoutWorkerHook"})}),"<",(0,r.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"The layout hook to use"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L32",children:"WorkerLayoutControl.tsx:32"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"settings"}),": ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsx)(n.p,{children:"Settings of the layout."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L37",children:"WorkerLayoutControl.tsx:37"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"style"}),": ",(0,r.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,r.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L27",children:"WorkerLayoutControl.tsx:27"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>l});var r=t(4041);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[379],{5682:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var r=t(1085),s=t(1184);const i={id:"WorkerLayoutControlProps",title:"Interface: WorkerLayoutControlProps",sidebar_label:"WorkerLayoutControlProps",sidebar_position:0,custom_edit_url:null},o=void 0,l={id:"api/layout-core/interfaces/WorkerLayoutControlProps",title:"Interface: WorkerLayoutControlProps",description:"Properties for WorkerLayoutControl component",source:"@site/docs/api/layout-core/interfaces/WorkerLayoutControlProps.md",sourceDirName:"api/layout-core/interfaces",slug:"/api/layout-core/interfaces/WorkerLayoutControlProps",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"WorkerLayoutControlProps",title:"Interface: WorkerLayoutControlProps",sidebar_label:"WorkerLayoutControlProps",sidebar_position:0,custom_edit_url:null},sidebar:"docs",previous:{title:"layout-core",permalink:"/react-sigma/docs/api/layout-core/"},next:{title:"layout-random",permalink:"/react-sigma/docs/api/layout-random/"}},d={},a=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"autoRunFor",id:"autorunfor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"labels",id:"labels",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"layout",id:"layout",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["Properties for ",(0,r.jsx)(n.code,{children:"WorkerLayoutControl"})," component"]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"autorunfor",children:"autoRunFor"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"autoRunFor"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.p,{children:"Option to tell what we do when the component is mounted"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)("code",{children:"-1"})," means that we do nothing (it's the same as no value)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)("code",{children:"0"})," means that we start the algo (and don't auto stop it)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)("code",{children:"X"})," mans that we start the algo, and stop it after X milliseconds"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L45",children:"WorkerLayoutControl.tsx:45"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"children"}),": [",(0,r.jsx)(n.code,{children:"Element"}),", ",(0,r.jsx)(n.code,{children:"Element"}),"]"]}),"\n",(0,r.jsx)(n.p,{children:'It\'s possible to customize the button, by passing to JSX Element.\nFirst one is for the "start layout", and the second to "stop layout".\nExample :'}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-jsx",children:"\n <>\n Start\n Stop\n \n\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L60",children:"WorkerLayoutControl.tsx:60"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"classname",children:"className"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"className"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"HTML class"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L22",children:"WorkerLayoutControl.tsx:22"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"HTML id"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L17",children:"WorkerLayoutControl.tsx:17"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"labels",children:"labels"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"labels"}),": ",(0,r.jsx)(n.code,{children:"Object"})]}),"\n",(0,r.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,r.jsx)(n.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"start"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"stop"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L66",children:"WorkerLayoutControl.tsx:66"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"layout",children:"layout"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"layout"}),": ",(0,r.jsx)(n.a,{href:"../#layoutworkerhook",children:(0,r.jsx)(n.code,{children:"LayoutWorkerHook"})}),"<",(0,r.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"The layout hook to use"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L32",children:"WorkerLayoutControl.tsx:32"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"settings"}),": ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsx)(n.p,{children:"Settings of the layout."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L37",children:"WorkerLayoutControl.tsx:37"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"style",children:"style"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.code,{children:"Optional"})," ",(0,r.jsx)(n.strong,{children:"style"}),": ",(0,r.jsx)(n.code,{children:"CSSProperties"})]}),"\n",(0,r.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L27",children:"WorkerLayoutControl.tsx:27"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>l});var r=t(4041);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eec79c8d.e9df5aa4.js b/assets/js/eec79c8d.aee5bcb7.js similarity index 98% rename from assets/js/eec79c8d.e9df5aa4.js rename to assets/js/eec79c8d.aee5bcb7.js index 73f7087c..0c7f9770 100644 --- a/assets/js/eec79c8d.e9df5aa4.js +++ b/assets/js/eec79c8d.aee5bcb7.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[55],{8690:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>n,metadata:()=>d,toc:()=>o});var l=r(1085),s=r(1184);const n={id:"index",title:"@react-sigma/layout-core",sidebar_label:"layout-core",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"api/layout-core/index",title:"@react-sigma/layout-core",description:"React Sigma core module for layouts.",source:"@site/docs/api/layout-core/index.md",sourceDirName:"api/layout-core",slug:"/api/layout-core/",permalink:"/react-sigma/docs/api/layout-core/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-core",sidebar_label:"layout-core",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps"},next:{title:"WorkerLayoutControlProps",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"}},c={},o=[{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"LayoutHook",id:"layouthook",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"LayoutWorkerHook",id:"layoutworkerhook",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"Functions",id:"functions",level:2},{value:"WorkerLayoutControl",id:"workerlayoutcontrol",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useLayoutFactory",id:"uselayoutfactory",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useWorkerLayoutFactory",id:"useworkerlayoutfactory",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function a(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.p,{children:"React Sigma core module for layouts.\nIt contains all the standard components & hooks for managing layout."}),"\n",(0,l.jsx)(t.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:(0,l.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",children:"WorkerLayoutControlProps"})}),"\n"]}),"\n",(0,l.jsx)(t.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,l.jsx)(t.h3,{id:"layouthook",children:"LayoutHook"}),"\n",(0,l.jsxs)(t.p,{children:["\u01ac ",(0,l.jsx)(t.strong,{children:"LayoutHook"}),"<",(0,l.jsx)(t.code,{children:"T"}),">: (",(0,l.jsx)(t.code,{children:"settings?"}),": ",(0,l.jsx)(t.code,{children:"T"}),") => { ",(0,l.jsx)(t.code,{children:"assign"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," ; ",(0,l.jsx)(t.code,{children:"positions"}),": () => { ",(0,l.jsx)(t.code,{children:"[node: string]"}),": { ",(0,l.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,l.jsx)(t.code,{children:"number"}),"; }; } }"]}),"\n",(0,l.jsx)(t.p,{children:"Generic type for layout hooks."}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 (",(0,l.jsx)(t.code,{children:"settings?"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsx)(t.h5,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings?"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})]})})]}),"\n",(0,l.jsx)(t.h5,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"assign"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"-"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"positions"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,l.jsx)(t.code,{children:"[node: string]"}),": { ",(0,l.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,l.jsx)(t.code,{children:"number"}),"; }; }"]}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"-"})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/useLayoutFactory.ts#L17",children:"useLayoutFactory.ts:17"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"layoutworkerhook",children:"LayoutWorkerHook"}),"\n",(0,l.jsxs)(t.p,{children:["\u01ac ",(0,l.jsx)(t.strong,{children:"LayoutWorkerHook"}),"<",(0,l.jsx)(t.code,{children:"T"}),">: (",(0,l.jsx)(t.code,{children:"settings"}),": ",(0,l.jsx)(t.code,{children:"T"}),") => { ",(0,l.jsx)(t.code,{children:"isRunning"}),": ",(0,l.jsx)(t.code,{children:"boolean"})," ; ",(0,l.jsx)(t.code,{children:"kill"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," ; ",(0,l.jsx)(t.code,{children:"start"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," ; ",(0,l.jsx)(t.code,{children:"stop"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," }"]}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"type-declaration-1",children:"Type declaration"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 (",(0,l.jsx)(t.code,{children:"settings"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsx)(t.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})]})})]}),"\n",(0,l.jsx)(t.h5,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"isRunning"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"boolean"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"kill"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"start"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"stop"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/useWorkerLayoutFactory.ts#L6",children:"useWorkerLayoutFactory.ts:6"})}),"\n",(0,l.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(t.h3,{id:"workerlayoutcontrol",children:"WorkerLayoutControl"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"WorkerLayoutControl"}),"<",(0,l.jsx)(t.code,{children:"T"}),">(",(0,l.jsx)(t.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(t.code,{children:"Element"})]}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"\xabdestructured\xbb"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",children:(0,l.jsx)(t.code,{children:"WorkerLayoutControlProps"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Element"})}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/WorkerLayoutControl.tsx#L69",children:"WorkerLayoutControl.tsx:69"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"uselayoutfactory",children:"useLayoutFactory"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useLayoutFactory"}),"<",(0,l.jsx)(t.code,{children:"T"}),">(",(0,l.jsx)(t.code,{children:"layout"}),", ",(0,l.jsx)(t.code,{children:"defaultSettings"}),"): ",(0,l.jsx)(t.a,{href:"#layouthook",children:(0,l.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.p,{children:"Factory for layout hook."}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-3",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"layout"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.code,{children:"GraphologyLayout"}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"defaultSettings"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.a,{href:"#layouthook",children:(0,l.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/useLayoutFactory.ts#L31",children:"useLayoutFactory.ts:31"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"useworkerlayoutfactory",children:"useWorkerLayoutFactory"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useWorkerLayoutFactory"}),"<",(0,l.jsx)(t.code,{children:"T"}),">(",(0,l.jsx)(t.code,{children:"worker"}),"): ",(0,l.jsx)(t.a,{href:"#layoutworkerhook",children:(0,l.jsx)(t.code,{children:"LayoutWorkerHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-4",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"worker"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.code,{children:"GraphologyWorkerLayoutConstructor"}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.a,{href:"#layoutworkerhook",children:(0,l.jsx)(t.code,{children:"LayoutWorkerHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-core/src/useWorkerLayoutFactory.ts#L23",children:"useWorkerLayoutFactory.ts:23"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>d});var l=r(4041);const s={},n=l.createContext(s);function i(e){const t=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[55],{8690:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>n,metadata:()=>d,toc:()=>o});var l=r(1085),s=r(1184);const n={id:"index",title:"@react-sigma/layout-core",sidebar_label:"layout-core",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"api/layout-core/index",title:"@react-sigma/layout-core",description:"React Sigma core module for layouts.",source:"@site/docs/api/layout-core/index.md",sourceDirName:"api/layout-core",slug:"/api/layout-core/",permalink:"/react-sigma/docs/api/layout-core/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-core",sidebar_label:"layout-core",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps"},next:{title:"WorkerLayoutControlProps",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"}},c={},o=[{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"LayoutHook",id:"layouthook",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"LayoutWorkerHook",id:"layoutworkerhook",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"Functions",id:"functions",level:2},{value:"WorkerLayoutControl",id:"workerlayoutcontrol",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useLayoutFactory",id:"uselayoutfactory",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useWorkerLayoutFactory",id:"useworkerlayoutfactory",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function a(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.p,{children:"React Sigma core module for layouts.\nIt contains all the standard components & hooks for managing layout."}),"\n",(0,l.jsx)(t.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:(0,l.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",children:"WorkerLayoutControlProps"})}),"\n"]}),"\n",(0,l.jsx)(t.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,l.jsx)(t.h3,{id:"layouthook",children:"LayoutHook"}),"\n",(0,l.jsxs)(t.p,{children:["\u01ac ",(0,l.jsx)(t.strong,{children:"LayoutHook"}),"<",(0,l.jsx)(t.code,{children:"T"}),">: (",(0,l.jsx)(t.code,{children:"settings?"}),": ",(0,l.jsx)(t.code,{children:"T"}),") => { ",(0,l.jsx)(t.code,{children:"assign"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," ; ",(0,l.jsx)(t.code,{children:"positions"}),": () => { ",(0,l.jsx)(t.code,{children:"[node: string]"}),": { ",(0,l.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,l.jsx)(t.code,{children:"number"}),"; }; } }"]}),"\n",(0,l.jsx)(t.p,{children:"Generic type for layout hooks."}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 (",(0,l.jsx)(t.code,{children:"settings?"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsx)(t.h5,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings?"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})]})})]}),"\n",(0,l.jsx)(t.h5,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"assign"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"-"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"positions"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,l.jsx)(t.code,{children:"[node: string]"}),": { ",(0,l.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,l.jsx)(t.code,{children:"number"}),"; }; }"]}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"-"})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/useLayoutFactory.ts#L17",children:"useLayoutFactory.ts:17"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"layoutworkerhook",children:"LayoutWorkerHook"}),"\n",(0,l.jsxs)(t.p,{children:["\u01ac ",(0,l.jsx)(t.strong,{children:"LayoutWorkerHook"}),"<",(0,l.jsx)(t.code,{children:"T"}),">: (",(0,l.jsx)(t.code,{children:"settings"}),": ",(0,l.jsx)(t.code,{children:"T"}),") => { ",(0,l.jsx)(t.code,{children:"isRunning"}),": ",(0,l.jsx)(t.code,{children:"boolean"})," ; ",(0,l.jsx)(t.code,{children:"kill"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," ; ",(0,l.jsx)(t.code,{children:"start"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," ; ",(0,l.jsx)(t.code,{children:"stop"}),": () => ",(0,l.jsx)(t.code,{children:"void"})," }"]}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"type-declaration-1",children:"Type declaration"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 (",(0,l.jsx)(t.code,{children:"settings"}),"): ",(0,l.jsx)(t.code,{children:"Object"})]}),"\n",(0,l.jsx)(t.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"settings"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})]})})]}),"\n",(0,l.jsx)(t.h5,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Object"})}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"isRunning"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"boolean"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"kill"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"start"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"stop"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(t.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/useWorkerLayoutFactory.ts#L6",children:"useWorkerLayoutFactory.ts:6"})}),"\n",(0,l.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(t.h3,{id:"workerlayoutcontrol",children:"WorkerLayoutControl"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"WorkerLayoutControl"}),"<",(0,l.jsx)(t.code,{children:"T"}),">(",(0,l.jsx)(t.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(t.code,{children:"Element"})]}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"\xabdestructured\xbb"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",children:(0,l.jsx)(t.code,{children:"WorkerLayoutControlProps"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.code,{children:"Element"})}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/WorkerLayoutControl.tsx#L69",children:"WorkerLayoutControl.tsx:69"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"uselayoutfactory",children:"useLayoutFactory"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useLayoutFactory"}),"<",(0,l.jsx)(t.code,{children:"T"}),">(",(0,l.jsx)(t.code,{children:"layout"}),", ",(0,l.jsx)(t.code,{children:"defaultSettings"}),"): ",(0,l.jsx)(t.a,{href:"#layouthook",children:(0,l.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.p,{children:"Factory for layout hook."}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-3",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"layout"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.code,{children:"GraphologyLayout"}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"defaultSettings"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})]})]})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.a,{href:"#layouthook",children:(0,l.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/useLayoutFactory.ts#L31",children:"useLayoutFactory.ts:31"})}),"\n",(0,l.jsx)(t.hr,{}),"\n",(0,l.jsx)(t.h3,{id:"useworkerlayoutfactory",children:"useWorkerLayoutFactory"}),"\n",(0,l.jsxs)(t.p,{children:["\u25b8 ",(0,l.jsx)(t.strong,{children:"useWorkerLayoutFactory"}),"<",(0,l.jsx)(t.code,{children:"T"}),">(",(0,l.jsx)(t.code,{children:"worker"}),"): ",(0,l.jsx)(t.a,{href:"#layoutworkerhook",children:(0,l.jsx)(t.code,{children:"LayoutWorkerHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.h4,{id:"type-parameters-4",children:"Type parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(t.tbody,{children:(0,l.jsx)(t.tr,{children:(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(t.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(t.tbody,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"worker"})}),(0,l.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,l.jsx)(t.code,{children:"GraphologyWorkerLayoutConstructor"}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]})]})})]}),"\n",(0,l.jsx)(t.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.a,{href:"#layoutworkerhook",children:(0,l.jsx)(t.code,{children:"LayoutWorkerHook"})}),"<",(0,l.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(t.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(t.p,{children:(0,l.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-core/src/useWorkerLayoutFactory.ts#L23",children:"useWorkerLayoutFactory.ts:23"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>d});var l=r(4041);const s={},n=l.createContext(s);function i(e){const t=l.useContext(n);return l.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f822d16e.ba7a178a.js b/assets/js/f822d16e.b9390103.js similarity index 98% rename from assets/js/f822d16e.ba7a178a.js rename to assets/js/f822d16e.b9390103.js index 7b6736be..383dbd3e 100644 --- a/assets/js/f822d16e.ba7a178a.js +++ b/assets/js/f822d16e.b9390103.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[387],{646:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=n(1085),i=n(1184);const r={id:"index",title:"@react-sigma/layout-random",sidebar_label:"layout-random",sidebar_position:.5,custom_edit_url:null},l=void 0,d={id:"api/layout-random/index",title:"@react-sigma/layout-random",description:"Functions",source:"@site/docs/api/layout-random/index.md",sourceDirName:"api/layout-random",slug:"/api/layout-random/",permalink:"/react-sigma/docs/api/layout-random/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-random",sidebar_label:"layout-random",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"WorkerLayoutControlProps",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"},next:{title:"layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"}},o={},a=[{value:"Functions",id:"functions",level:2},{value:"useLayoutRandom",id:"uselayoutrandom",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function c(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,s.jsx)(t.h3,{id:"uselayoutrandom",children:"useLayoutRandom"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"useLayoutRandom"}),"(",(0,s.jsx)(t.code,{children:"settings?"}),"): ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"settings?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"RandomLayoutOptions"})})]})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Object"})}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"assign"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"positions"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,s.jsx)(t.code,{children:"[node: string]"}),": { ",(0,s.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,s.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/4b3a2e2/packages/layout-random/src/useLayoutRandom.ts#L14",children:"layout-random/src/useLayoutRandom.ts:14"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>d});var s=n(4041);const i={},r=s.createContext(i);function l(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[387],{646:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=n(1085),i=n(1184);const r={id:"index",title:"@react-sigma/layout-random",sidebar_label:"layout-random",sidebar_position:.5,custom_edit_url:null},l=void 0,d={id:"api/layout-random/index",title:"@react-sigma/layout-random",description:"Functions",source:"@site/docs/api/layout-random/index.md",sourceDirName:"api/layout-random",slug:"/api/layout-random/",permalink:"/react-sigma/docs/api/layout-random/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"index",title:"@react-sigma/layout-random",sidebar_label:"layout-random",sidebar_position:.5,custom_edit_url:null},sidebar:"docs",previous:{title:"WorkerLayoutControlProps",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"},next:{title:"layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"}},o={},a=[{value:"Functions",id:"functions",level:2},{value:"useLayoutRandom",id:"uselayoutrandom",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function c(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,s.jsx)(t.h3,{id:"uselayoutrandom",children:"useLayoutRandom"}),"\n",(0,s.jsxs)(t.p,{children:["\u25b8 ",(0,s.jsx)(t.strong,{children:"useLayoutRandom"}),"(",(0,s.jsx)(t.code,{children:"settings?"}),"): ",(0,s.jsx)(t.code,{children:"Object"})]}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"settings?"})}),(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"RandomLayoutOptions"})})]})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Object"})}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"assign"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => ",(0,s.jsx)(t.code,{children:"void"})]})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{style:{textAlign:"left"},children:(0,s.jsx)(t.code,{children:"positions"})}),(0,s.jsxs)(t.td,{style:{textAlign:"left"},children:["() => { ",(0,s.jsx)(t.code,{children:"[node: string]"}),": { ",(0,s.jsx)(t.code,{children:"[dimension: string]"}),": ",(0,s.jsx)(t.code,{children:"number"}),"; }; }"]})]})]})]}),"\n",(0,s.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/465a82b/packages/layout-random/src/useLayoutRandom.ts#L14",children:"layout-random/src/useLayoutRandom.ts:14"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>d});var s=n(4041);const i={},r=s.createContext(i);function l(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.2c8f6948.js b/assets/js/runtime~main.3cda0112.js similarity index 59% rename from assets/js/runtime~main.2c8f6948.js rename to assets/js/runtime~main.3cda0112.js index e3141304..c6fec0be 100644 --- a/assets/js/runtime~main.2c8f6948.js +++ b/assets/js/runtime~main.3cda0112.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,c,f={},d={};function o(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return f[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=f,o.c=d,o.amdD=function(){throw new Error("define cannot be used indirect")},o.amdO={},e=[],o.O=(a,t,r,c)=>{if(!t){var f=1/0;for(b=0;b=c)&&Object.keys(o.O).every((e=>o.O[e](t[n])))?t.splice(n--,1):(d=!1,c0&&e[b-1][2]>c;b--)e[b]=e[b-1];e[b]=[t,r,c]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var c=Object.create(null);o.r(c);var f={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,o.d(c,f),c},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({16:"6c3cbc8a",48:"a94703ab",55:"eec79c8d",70:"0480b142",98:"a7bd4aaa",146:"47a287a0",266:"86602c7e",272:"735d0569",379:"e9d20596",387:"f822d16e",401:"17896441",441:"2c32c100",459:"958d1a80",519:"e82272c9",581:"935f2afb",583:"1df93b7f",592:"566af407",624:"5fbc5cf1",647:"5e95c892",653:"de170a46",701:"0e29f09e",711:"1aa56bec",765:"32dd47bd",770:"a2f529ce",784:"28a50278",799:"999d5064",803:"12bf14a9",804:"f744d675",811:"737f273a",823:"3e23a349",846:"2c3f03d4",881:"f7d9daf5",885:"a1f74bf5",907:"22f670d9",969:"a6d01e9f"}[e]||e)+"."+{16:"3d21f077",48:"3fddc000",55:"e9df5aa4",70:"3e040b02",98:"db93d8d4",146:"4528757a",147:"3f81282e",184:"a309038e",266:"f58bd88e",272:"5a657872",379:"64ebd800",387:"ba7a178a",401:"48fe83af",441:"bfd23e93",459:"27e67060",506:"641ac754",519:"9833b66b",548:"78259a12",581:"a48633e7",583:"f9edb058",592:"2c67cba0",611:"a50a780b",624:"bcf34139",647:"229a83c3",653:"3b571217",701:"28cc3cb2",711:"b185126c",723:"daffadfa",724:"c58ae9e9",765:"b28dcdae",770:"e3db937d",784:"03628e3f",799:"e9c61496",803:"a026e630",804:"52a444f0",811:"340b4e1e",823:"e74f8b17",846:"55f676e3",881:"400b74b6",885:"bbb1abaf",907:"ccff50aa",969:"4d2b0903",995:"69c0d12f"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},c="@react-sigma/website:",o.l=(e,a,t,f)=>{if(r[e])r[e].push(a);else{var d,n;if(void 0!==t)for(var i=document.getElementsByTagName("script"),b=0;b{d.onerror=d.onload=null,clearTimeout(s);var c=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),c&&c.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),n&&document.head.appendChild(d)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),o.p="/react-sigma/",o.gca=function(e){return e={17896441:"401","6c3cbc8a":"16",a94703ab:"48",eec79c8d:"55","0480b142":"70",a7bd4aaa:"98","47a287a0":"146","86602c7e":"266","735d0569":"272",e9d20596:"379",f822d16e:"387","2c32c100":"441","958d1a80":"459",e82272c9:"519","935f2afb":"581","1df93b7f":"583","566af407":"592","5fbc5cf1":"624","5e95c892":"647",de170a46:"653","0e29f09e":"701","1aa56bec":"711","32dd47bd":"765",a2f529ce:"770","28a50278":"784","999d5064":"799","12bf14a9":"803",f744d675:"804","737f273a":"811","3e23a349":"823","2c3f03d4":"846",f7d9daf5:"881",a1f74bf5:"885","22f670d9":"907",a6d01e9f:"969"}[e]||e,o.p+o.u(e)},(()=>{var e={354:0,869:0};o.f.j=(a,t)=>{var r=o.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(354|869)$/.test(a))e[a]=0;else{var c=new Promise(((t,c)=>r=e[a]=[t,c]));t.push(r[2]=c);var f=o.p+o.u(a),d=new Error;o.l(f,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var c=t&&("load"===t.type?"missing":t.type),f=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",d.name="ChunkLoadError",d.type=c,d.request=f,r[1](d)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,c,f=t[0],d=t[1],n=t[2],i=0;if(f.some((a=>0!==e[a]))){for(r in d)o.o(d,r)&&(o.m[r]=d[r]);if(n)var b=n(o)}for(a&&a(t);i{"use strict";var e,a,t,r,c,d={},f={};function o(e){var a=f[e];if(void 0!==a)return a.exports;var t=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=d,o.c=f,o.amdD=function(){throw new Error("define cannot be used indirect")},o.amdO={},e=[],o.O=(a,t,r,c)=>{if(!t){var d=1/0;for(b=0;b=c)&&Object.keys(o.O).every((e=>o.O[e](t[n])))?t.splice(n--,1):(f=!1,c0&&e[b-1][2]>c;b--)e[b]=e[b-1];e[b]=[t,r,c]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var c=Object.create(null);o.r(c);var d={};a=a||[null,t({}),t([]),t(t)];for(var f=2&r&&e;"object"==typeof f&&!~a.indexOf(f);f=t(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,o.d(c,d),c},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({16:"6c3cbc8a",48:"a94703ab",55:"eec79c8d",70:"0480b142",98:"a7bd4aaa",146:"47a287a0",266:"86602c7e",272:"735d0569",379:"e9d20596",387:"f822d16e",401:"17896441",441:"2c32c100",459:"958d1a80",519:"e82272c9",581:"935f2afb",583:"1df93b7f",592:"566af407",624:"5fbc5cf1",647:"5e95c892",653:"de170a46",701:"0e29f09e",711:"1aa56bec",765:"32dd47bd",770:"a2f529ce",784:"28a50278",799:"999d5064",803:"12bf14a9",804:"f744d675",811:"737f273a",823:"3e23a349",846:"2c3f03d4",881:"f7d9daf5",885:"a1f74bf5",907:"22f670d9",969:"a6d01e9f"}[e]||e)+"."+{16:"028f37fb",48:"3fddc000",55:"aee5bcb7",70:"3e040b02",98:"db93d8d4",146:"15c7666b",147:"3f81282e",184:"a309038e",266:"f58bd88e",272:"5a657872",379:"8b41f9f9",387:"b9390103",401:"48fe83af",441:"b385ba50",459:"e26b9d10",506:"641ac754",519:"f0384b12",548:"78259a12",581:"a48633e7",583:"f9edb058",592:"2c67cba0",611:"a50a780b",624:"bcf34139",647:"229a83c3",653:"de9f4eaa",701:"02b8ddd6",711:"cd5aaf76",723:"daffadfa",724:"c58ae9e9",765:"9511ae0b",770:"1bec4d80",784:"03911ebb",799:"67382351",803:"a026e630",804:"52a444f0",811:"340b4e1e",823:"e74f8b17",846:"55f676e3",881:"400b74b6",885:"bbb1abaf",907:"ccff50aa",969:"4d2b0903",995:"69c0d12f"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},c="@react-sigma/website:",o.l=(e,a,t,d)=>{if(r[e])r[e].push(a);else{var f,n;if(void 0!==t)for(var i=document.getElementsByTagName("script"),b=0;b{f.onerror=f.onload=null,clearTimeout(s);var c=r[e];if(delete r[e],f.parentNode&&f.parentNode.removeChild(f),c&&c.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),n&&document.head.appendChild(f)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),o.p="/react-sigma/",o.gca=function(e){return e={17896441:"401","6c3cbc8a":"16",a94703ab:"48",eec79c8d:"55","0480b142":"70",a7bd4aaa:"98","47a287a0":"146","86602c7e":"266","735d0569":"272",e9d20596:"379",f822d16e:"387","2c32c100":"441","958d1a80":"459",e82272c9:"519","935f2afb":"581","1df93b7f":"583","566af407":"592","5fbc5cf1":"624","5e95c892":"647",de170a46:"653","0e29f09e":"701","1aa56bec":"711","32dd47bd":"765",a2f529ce:"770","28a50278":"784","999d5064":"799","12bf14a9":"803",f744d675:"804","737f273a":"811","3e23a349":"823","2c3f03d4":"846",f7d9daf5:"881",a1f74bf5:"885","22f670d9":"907",a6d01e9f:"969"}[e]||e,o.p+o.u(e)},(()=>{var e={354:0,869:0};o.f.j=(a,t)=>{var r=o.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(354|869)$/.test(a))e[a]=0;else{var c=new Promise(((t,c)=>r=e[a]=[t,c]));t.push(r[2]=c);var d=o.p+o.u(a),f=new Error;o.l(d,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var c=t&&("load"===t.type?"missing":t.type),d=t&&t.target&&t.target.src;f.message="Loading chunk "+a+" failed.\n("+c+": "+d+")",f.name="ChunkLoadError",f.type=c,f.request=d,r[1](f)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,c,d=t[0],f=t[1],n=t[2],i=0;if(d.some((a=>0!==e[a]))){for(r in f)o.o(f,r)&&(o.m[r]=f[r]);if(n)var b=n(o)}for(a&&a(t);i @react-sigma/core | React Sigma - + @@ -31,7 +31,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/core/src/components/controls/ControlsContainer.tsx:44

+

packages/core/src/components/controls/ControlsContainer.tsx:44

FullScreenControl​

▸ FullScreenControl(props, context?): ReactNode

@@ -43,7 +43,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:67

+

packages/core/src/components/controls/FullScreenControl.tsx:67

SearchControl​

▸ SearchControl(props, context?): ReactNode

@@ -57,7 +57,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/core/src/components/controls/SearchControl.tsx:53

+

packages/core/src/components/controls/SearchControl.tsx:53

ZoomControl​

▸ ZoomControl(props, context?): ReactNode

@@ -74,7 +74,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/core/src/components/controls/ZoomControl.tsx:67

+

packages/core/src/components/controls/ZoomControl.tsx:67

Hook​

useCamera​

▸ useCamera(options?): Object

@@ -86,7 +86,7 @@

ReturnsNameTypegoto(state: Partial<CameraState>, options?: Partial<AnimateOptions>) => voidgotoNode(nodeKey: string, options?: Partial<AnimateOptions>) => voidreset(options?: Partial<AnimateOptions>) => voidzoomIn(options?: CameraOptions) => voidzoomOut(options?: CameraOptions) => void

Defined in​

-

packages/core/src/hooks/useCamera.ts:19

+

packages/core/src/hooks/useCamera.ts:19

useFullScreen​

▸ useFullScreen(container?): Object

@@ -98,7 +98,7 @@

ReturnsNameTypeisFullScreenbooleantoggle() => void

Defined in​

-

packages/core/src/hooks/useFullScreen.ts:22

+

packages/core/src/hooks/useFullScreen.ts:22

useLoadGraph​

▸ useLoadGraph<N, E, G>(): (graph: Graph<N, E, G>, clear?: boolean) => void

@@ -116,7 +116,7 @@
ParametersReturns​

void

Defined in​

-

packages/core/src/hooks/useLoadGraph.ts:21

+

packages/core/src/hooks/useLoadGraph.ts:21

useRegisterEvents​

▸ useRegisterEvents<N, E, G>(): (eventHandlers: Partial<EventHandlers>) => void

@@ -133,7 +133,7 @@
ParametersReturns​

void

Defined in​

-

packages/core/src/hooks/useRegisterEvents.ts:83

+

packages/core/src/hooks/useRegisterEvents.ts:83

useSetSettings​

▸ useSetSettings<N, E, G>(): (newSettings: Partial<Settings<N, E, G>>) => void

@@ -149,7 +149,7 @@
ParametersReturns​

void

Defined in​

-

packages/core/src/hooks/useSetSettings.ts:22

+

packages/core/src/hooks/useSetSettings.ts:22

useSigma​

▸ useSigma<N, E, G>(): Sigma<N, E, G>

@@ -160,7 +160,7 @@

Type param

Returns​

Sigma<N, E, G>

Defined in​

-

packages/core/src/hooks/useSigma.ts:14

+

packages/core/src/hooks/useSigma.ts:14

useSigmaContext​

▸ useSigmaContext<N, E, G>(): SigmaContextInterface<N, E, G>

@@ -172,20 +172,20 @@

Type param

Returns​

SigmaContextInterface<N, E, G>

Defined in​

-

packages/core/src/hooks/context.ts:34

+

packages/core/src/hooks/context.ts:34

Other​

EventHandlers​

Ƭ EventHandlers: SigmaEvents & TouchCaptorEvents & MouseCaptorEvents & CameraEvents

Sigma's events

Defined in​

-

packages/core/src/types.ts:7

+

packages/core/src/types.ts:7

GraphType​

Ƭ GraphType<N, E, G>: AbstractGraph<N, E, G> | GraphConstructor<N, E, G>

Type parameters​

NameType
Nextends Attributes = Attributes
Eextends Attributes = Attributes
Gextends Attributes = Attributes

Defined in​

-

packages/core/src/types.ts:17

+

packages/core/src/types.ts:17

SigmaContainer​

▸ SigmaContainer<N, E, G>(props): ReactElement<any, string | JSXElementConstructor<any>>

@@ -196,14 +196,14 @@

ParametersReturns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

-

packages/core/src/components/SigmaContainer.tsx:141

+

packages/core/src/components/SigmaContainer.tsx:141

getUniqueKey​

▸ getUniqueKey(): string

Returns​

string

Defined in​

-

packages/core/src/utils.ts:1

+

packages/core/src/utils.ts:1

isEqual​

▸ isEqual(x, y): boolean

@@ -212,6 +212,6 @@

ParametersReturns​

boolean

Defined in​

-

packages/core/src/utils.ts:5

+

packages/core/src/utils.ts:5

\ No newline at end of file diff --git a/docs/api/core/interfaces/ControlsContainerProps/index.html b/docs/api/core/interfaces/ControlsContainerProps/index.html index 6a4b8e30..ab78c3ba 100644 --- a/docs/api/core/interfaces/ControlsContainerProps/index.html +++ b/docs/api/core/interfaces/ControlsContainerProps/index.html @@ -5,7 +5,7 @@ Interface: ControlsContainerProps | React Sigma - + @@ -14,30 +14,30 @@

Propertieschildren​

• Optional children: ReactNode

Defined in​

-

packages/core/src/components/controls/ControlsContainer.tsx:26

+

packages/core/src/components/controls/ControlsContainer.tsx:26

className​

• Optional className: string

HTML class

Defined in​

-

packages/core/src/components/controls/ControlsContainer.tsx:14

+

packages/core/src/components/controls/ControlsContainer.tsx:14

id​

• Optional id: string

HTML id

Defined in​

-

packages/core/src/components/controls/ControlsContainer.tsx:10

+

packages/core/src/components/controls/ControlsContainer.tsx:10

position​

• Optional position: "top-right" | "top-left" | "bottom-right" | "bottom-left"

Position of the container

Defined in​

-

packages/core/src/components/controls/ControlsContainer.tsx:22

+

packages/core/src/components/controls/ControlsContainer.tsx:22

style​

• Optional style: CSSProperties

HTML CSS style

Defined in​

-

packages/core/src/components/controls/ControlsContainer.tsx:18

+

packages/core/src/components/controls/ControlsContainer.tsx:18

\ No newline at end of file diff --git a/docs/api/core/interfaces/FullScreenControlProps/index.html b/docs/api/core/interfaces/FullScreenControlProps/index.html index d179e6ce..aa251e44 100644 --- a/docs/api/core/interfaces/FullScreenControlProps/index.html +++ b/docs/api/core/interfaces/FullScreenControlProps/index.html @@ -5,7 +5,7 @@ Interface: FullScreenControlProps | React Sigma - + @@ -18,25 +18,25 @@

children
<FullScreenControl>
  <BiFullscreen />
  <BiExitFullscreen />
</FullScreenControl>

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:44

+

packages/core/src/components/controls/FullScreenControl.tsx:44

className​

• Optional className: string

HTML class

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:21

+

packages/core/src/components/controls/FullScreenControl.tsx:21

container​

• Optional container: RefObject<HTMLElement>

If defined, this container will be taken for the fullscreen instead of the sigma one.

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:31

+

packages/core/src/components/controls/FullScreenControl.tsx:31

id​

• Optional id: string

HTML id

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:16

+

packages/core/src/components/controls/FullScreenControl.tsx:16

labels​

• Optional labels: Object

@@ -45,12 +45,12 @@

labelsType declaration​

NameType
enterundefined | string
exitundefined | string

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:50

+

packages/core/src/components/controls/FullScreenControl.tsx:50

style​

• Optional style: CSSProperties

HTML CSS style

Defined in​

-

packages/core/src/components/controls/FullScreenControl.tsx:26

+

packages/core/src/components/controls/FullScreenControl.tsx:26

\ No newline at end of file diff --git a/docs/api/core/interfaces/SearchControlProps/index.html b/docs/api/core/interfaces/SearchControlProps/index.html index bba1b11e..01086bef 100644 --- a/docs/api/core/interfaces/SearchControlProps/index.html +++ b/docs/api/core/interfaces/SearchControlProps/index.html @@ -5,7 +5,7 @@ Interface: SearchControlProps | React Sigma - + @@ -15,13 +15,13 @@

classNameDefined in​

-

packages/core/src/components/controls/SearchControl.tsx:23

+

packages/core/src/components/controls/SearchControl.tsx:23

id​

• Optional id: string

HTML id

Defined in​

-

packages/core/src/components/controls/SearchControl.tsx:18

+

packages/core/src/components/controls/SearchControl.tsx:18

labels​

• Optional labels: Object

@@ -30,12 +30,12 @@

labelsType declaration​

NameType
placeholderundefined | string
textundefined | string

Defined in​

-

packages/core/src/components/controls/SearchControl.tsx:34

+

packages/core/src/components/controls/SearchControl.tsx:34

style​

• Optional style: CSSProperties

HTML CSS style

Defined in​

-

packages/core/src/components/controls/SearchControl.tsx:28

+

packages/core/src/components/controls/SearchControl.tsx:28

\ No newline at end of file diff --git a/docs/api/core/interfaces/SigmaContainerProps/index.html b/docs/api/core/interfaces/SigmaContainerProps/index.html index 1b37c430..272b9ffb 100644 --- a/docs/api/core/interfaces/SigmaContainerProps/index.html +++ b/docs/api/core/interfaces/SigmaContainerProps/index.html @@ -5,7 +5,7 @@ Interface: SigmaContainerProps<N, E, G> | React Sigma - + @@ -17,30 +17,30 @@

classNameDefined in​

-

packages/core/src/components/SigmaContainer.tsx:41

+

packages/core/src/components/SigmaContainer.tsx:41

graph​

• Optional graph: GraphType<N, E, G>

Graphology instance or constructor

Defined in​

-

packages/core/src/components/SigmaContainer.tsx:29

+

packages/core/src/components/SigmaContainer.tsx:29

id​

• Optional id: string

HTML id

Defined in​

-

packages/core/src/components/SigmaContainer.tsx:37

+

packages/core/src/components/SigmaContainer.tsx:37

settings​

• Optional settings: Partial<Settings<N, E, G>>

Sigma settings

Defined in​

-

packages/core/src/components/SigmaContainer.tsx:33

+

packages/core/src/components/SigmaContainer.tsx:33

style​

• Optional style: CSSProperties

HTML CSS style

Defined in​

-

packages/core/src/components/SigmaContainer.tsx:45

+

packages/core/src/components/SigmaContainer.tsx:45

\ No newline at end of file diff --git a/docs/api/core/interfaces/SigmaContextInterface/index.html b/docs/api/core/interfaces/SigmaContextInterface/index.html index e5a5dcdc..a30a0274 100644 --- a/docs/api/core/interfaces/SigmaContextInterface/index.html +++ b/docs/api/core/interfaces/SigmaContextInterface/index.html @@ -5,7 +5,7 @@ Interface: SigmaContextInterface<N, E, G> | React Sigma - + @@ -15,11 +15,11 @@

Propertiescontainer​

• container: HTMLElement

Defined in​

-

packages/core/src/hooks/context.ts:11

+

packages/core/src/hooks/context.ts:11

sigma​

• sigma: default<N, E, G>

Defined in​

-

packages/core/src/hooks/context.ts:10

+

packages/core/src/hooks/context.ts:10

\ No newline at end of file diff --git a/docs/api/core/interfaces/ZoomControlProps/index.html b/docs/api/core/interfaces/ZoomControlProps/index.html index e4725a7f..a66d8dcd 100644 --- a/docs/api/core/interfaces/ZoomControlProps/index.html +++ b/docs/api/core/interfaces/ZoomControlProps/index.html @@ -5,7 +5,7 @@ Interface: ZoomControlProps | React Sigma - + @@ -15,7 +15,7 @@

animationD

• Optional animationDuration: number

Number of ms for the zoom animation (default is 200ms)

Defined in​

-

packages/core/src/components/controls/ZoomControl.tsx:27

+

packages/core/src/components/controls/ZoomControl.tsx:27

children​

• Optional children: [Element, Element, Element]

@@ -24,13 +24,13 @@

children
<ZoomControl>
  <BsZoomIn />
  <BsZoomOut />
  <BiReset />
</FullScreenControl>

Defined in​

-

packages/core/src/components/controls/ZoomControl.tsx:41

+

packages/core/src/components/controls/ZoomControl.tsx:41

className​

• Optional className: string

HTML class that will be added to all div button wrapper

Defined in​

-

packages/core/src/components/controls/ZoomControl.tsx:17

+

packages/core/src/components/controls/ZoomControl.tsx:17

labels​

• Optional labels: Object

@@ -39,12 +39,12 @@

labelsType declaration​

NameType
resetundefined | string
zoomInundefined | string
zoomOutundefined | string

Defined in​

-

packages/core/src/components/controls/ZoomControl.tsx:47

+

packages/core/src/components/controls/ZoomControl.tsx:47

style​

• Optional style: CSSProperties

HTML CSS style that will be added to all div button wrapper

Defined in​

-

packages/core/src/components/controls/ZoomControl.tsx:22

+

packages/core/src/components/controls/ZoomControl.tsx:22

\ No newline at end of file diff --git a/docs/api/index.html b/docs/api/index.html index bfbbde7e..f69b317d 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -5,7 +5,7 @@ Project structure | React Sigma - + diff --git a/docs/api/layout-circlepack/index.html b/docs/api/layout-circlepack/index.html index 5c749d5c..c828e328 100644 --- a/docs/api/layout-circlepack/index.html +++ b/docs/api/layout-circlepack/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-circlepack | React Sigma - + @@ -21,6 +21,6 @@

ReturnsNameTypeassign() => voidpositions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

-

layout-circlepack/src/useLayoutCirclepack.ts:13

+

layout-circlepack/src/useLayoutCirclepack.ts:13

\ No newline at end of file diff --git a/docs/api/layout-circular/index.html b/docs/api/layout-circular/index.html index 4cf1b2ce..6bdda9a7 100644 --- a/docs/api/layout-circular/index.html +++ b/docs/api/layout-circular/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-circular | React Sigma - + @@ -20,6 +20,6 @@

ReturnsNameTypeassign() => voidpositions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

-

layout-circular/src/useLayoutCircular.ts:13

+

layout-circular/src/useLayoutCircular.ts:13

\ No newline at end of file diff --git a/docs/api/layout-core/index.html b/docs/api/layout-core/index.html index ba3c557c..56c5775a 100644 --- a/docs/api/layout-core/index.html +++ b/docs/api/layout-core/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-core | React Sigma - + @@ -29,7 +29,7 @@

ReturnsNameTypeDescriptionassign() => void-positions() => { [node: string]: { [dimension: string]: number; }; }-

Defined in​

-

useLayoutFactory.ts:17

+

useLayoutFactory.ts:17

LayoutWorkerHook​

Ƭ LayoutWorkerHook<T>: (settings: T) => { isRunning: boolean ; kill: () => void ; start: () => void ; stop: () => void }

@@ -43,7 +43,7 @@
ReturnsNameTypeisRunningbooleankill() => voidstart() => voidstop() => void

Defined in​

-

useWorkerLayoutFactory.ts:6

+

useWorkerLayoutFactory.ts:6

Functions​

WorkerLayoutControl​

▸ WorkerLayoutControl<T>(«destructured»): Element

@@ -54,7 +54,7 @@

ParametersReturns​

Element

Defined in​

-

WorkerLayoutControl.tsx:69

+

WorkerLayoutControl.tsx:69

useLayoutFactory​

▸ useLayoutFactory<T>(layout, defaultSettings): LayoutHook<T>

@@ -66,7 +66,7 @@

ParametersReturns​

LayoutHook<T>

Defined in​

-

useLayoutFactory.ts:31

+

useLayoutFactory.ts:31

useWorkerLayoutFactory​

▸ useWorkerLayoutFactory<T>(worker): LayoutWorkerHook<T>

@@ -77,6 +77,6 @@

ParametersReturns​

LayoutWorkerHook<T>

Defined in​

-

useWorkerLayoutFactory.ts:23

+

useWorkerLayoutFactory.ts:23

\ No newline at end of file diff --git a/docs/api/layout-core/interfaces/WorkerLayoutControlProps/index.html b/docs/api/layout-core/interfaces/WorkerLayoutControlProps/index.html index f5e453a6..3e0005ae 100644 --- a/docs/api/layout-core/interfaces/WorkerLayoutControlProps/index.html +++ b/docs/api/layout-core/interfaces/WorkerLayoutControlProps/index.html @@ -5,7 +5,7 @@ Interface: WorkerLayoutControlProps<T> | React Sigma - + @@ -22,7 +22,7 @@

autoRunForX mans that we start the algo, and stop it after X milliseconds

Defined in​

-

WorkerLayoutControl.tsx:45

+

WorkerLayoutControl.tsx:45

children​

• Optional children: [Element, Element]

@@ -31,19 +31,19 @@

children
<WorkerLayoutControl>
  <>
    <span>Start</span>
    <span>Stop</span>
  </>
</WorkerLayoutControl>

Defined in​

-

WorkerLayoutControl.tsx:60

+

WorkerLayoutControl.tsx:60

className​

• Optional className: string

HTML class

Defined in​

-

WorkerLayoutControl.tsx:22

+

WorkerLayoutControl.tsx:22

id​

• Optional id: string

HTML id

Defined in​

-

WorkerLayoutControl.tsx:17

+

WorkerLayoutControl.tsx:17

labels​

• Optional labels: Object

@@ -52,24 +52,24 @@

labelsType declaration​

NameType
startundefined | string
stopundefined | string

Defined in​

-

WorkerLayoutControl.tsx:66

+

WorkerLayoutControl.tsx:66

layout​

• layout: LayoutWorkerHook<T>

The layout hook to use

Defined in​

-

WorkerLayoutControl.tsx:32

+

WorkerLayoutControl.tsx:32

settings​

• settings: T

Settings of the layout.

Defined in​

-

WorkerLayoutControl.tsx:37

+

WorkerLayoutControl.tsx:37

style​

• Optional style: CSSProperties

HTML CSS style

Defined in​

-

WorkerLayoutControl.tsx:27

+

WorkerLayoutControl.tsx:27

\ No newline at end of file diff --git a/docs/api/layout-force/index.html b/docs/api/layout-force/index.html index 9af284f5..31161774 100644 --- a/docs/api/layout-force/index.html +++ b/docs/api/layout-force/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-force | React Sigma - + @@ -18,7 +18,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/layout-force/src/LayoutForceControl.tsx:22

+

packages/layout-force/src/LayoutForceControl.tsx:22

Hook​

useLayoutForce​

▸ useLayoutForce(settings?): Object

@@ -30,7 +30,7 @@

ReturnsNameTypeassign() => voidpositions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

-

packages/layout-force/src/useLayoutForce.ts:13

+

packages/layout-force/src/useLayoutForce.ts:13

useWorkerLayoutForce​

▸ useWorkerLayoutForce(settings): Object

@@ -42,12 +42,12 @@

ReturnsNameTypeisRunningbooleankill() => voidstart() => voidstop() => void

Defined in​

-

packages/layout-force/src/useWorkerLayoutForce.ts:13

+

packages/layout-force/src/useWorkerLayoutForce.ts:13

Other​

LayoutForceControlProps​

Ƭ LayoutForceControlProps: Omit<WorkerLayoutControlProps<ForceLayoutSupervisorParameters>, "layout" | "settings"> & { settings?: ForceLayoutSupervisorParameters }

Properties for ForceDirectedControl component

Defined in​

-

packages/layout-force/src/LayoutForceControl.tsx:10

+

packages/layout-force/src/LayoutForceControl.tsx:10

\ No newline at end of file diff --git a/docs/api/layout-forceatlas2/index.html b/docs/api/layout-forceatlas2/index.html index 2f6e83f1..91d4cf31 100644 --- a/docs/api/layout-forceatlas2/index.html +++ b/docs/api/layout-forceatlas2/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-forceatlas2 | React Sigma - + @@ -17,7 +17,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20

+

packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20

Hook​

useLayoutForceAtlas2​

▸ useLayoutForceAtlas2(settings?): Object

@@ -29,7 +29,7 @@

ReturnsNameTypeassign() => voidpositions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

-

packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13

+

packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13

useWorkerLayoutForceAtlas2​

▸ useWorkerLayoutForceAtlas2(settings): Object

@@ -41,12 +41,12 @@

ReturnsNameTypeisRunningbooleankill() => voidstart() => voidstop() => void

Defined in​

-

packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14

+

packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14

Other​

LayoutForceAtlas2ControlProps​

Ƭ LayoutForceAtlas2ControlProps: Omit<WorkerLayoutControlProps<ForceAtlas2LayoutParameters>, "layout" | "settings"> & { settings?: ForceAtlas2LayoutParameters }

Properties for LayoutForceAtlas2Control component

Defined in​

-

packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10

+

packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10

\ No newline at end of file diff --git a/docs/api/layout-noverlap/index.html b/docs/api/layout-noverlap/index.html index fff1b0ee..3e2e52e5 100644 --- a/docs/api/layout-noverlap/index.html +++ b/docs/api/layout-noverlap/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-noverlap | React Sigma - + @@ -17,7 +17,7 @@

ParametersReturns​

ReactNode

Defined in​

-

packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20

+

packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20

Hook​

useLayoutNoverlap​

▸ useLayoutNoverlap(settings?): Object

@@ -29,7 +29,7 @@

ReturnsNameTypeassign() => voidpositions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

-

packages/layout-noverlap/src/useLayoutNoverlap.ts:13

+

packages/layout-noverlap/src/useLayoutNoverlap.ts:13

useWorkerLayoutNoverlap​

▸ useWorkerLayoutNoverlap(settings): Object

@@ -41,12 +41,12 @@

ReturnsNameTypeisRunningbooleankill() => voidstart() => voidstop() => void

Defined in​

-

packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13

+

packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13

Other​

LayoutNoverlapControlProps​

Ƭ LayoutNoverlapControlProps: Omit<WorkerLayoutControlProps<NoverlapLayoutSupervisorParameters>, "layout" | "settings"> & { settings?: NoverlapLayoutSupervisorParameters }

Properties for NoverlapControl component

Defined in​

-

packages/layout-noverlap/src/LayoutNoverlapControl.tsx:10

+

packages/layout-noverlap/src/LayoutNoverlapControl.tsx:10

\ No newline at end of file diff --git a/docs/api/layout-random/index.html b/docs/api/layout-random/index.html index 05f51607..d0b87af7 100644 --- a/docs/api/layout-random/index.html +++ b/docs/api/layout-random/index.html @@ -5,7 +5,7 @@ @react-sigma/layout-random | React Sigma - + @@ -18,6 +18,6 @@

ReturnsNameTypeassign() => voidpositions() => { [node: string]: { [dimension: string]: number; }; }

Defined in​

-

layout-random/src/useLayoutRandom.ts:14

+

layout-random/src/useLayoutRandom.ts:14

\ No newline at end of file diff --git a/docs/changelog/index.html b/docs/changelog/index.html index 3661df3b..e921752a 100644 --- a/docs/changelog/index.html +++ b/docs/changelog/index.html @@ -5,7 +5,7 @@ changelog | React Sigma - + diff --git a/docs/example/controls/index.html b/docs/example/controls/index.html index 761d7b70..5c2b71f9 100644 --- a/docs/example/controls/index.html +++ b/docs/example/controls/index.html @@ -5,7 +5,7 @@ Controls | React Sigma - + diff --git a/docs/example/drag_n_drop/index.html b/docs/example/drag_n_drop/index.html index dafa8fb1..cfd8ba69 100644 --- a/docs/example/drag_n_drop/index.html +++ b/docs/example/drag_n_drop/index.html @@ -5,7 +5,7 @@ Drag'n'Drop | React Sigma - + diff --git a/docs/example/events/index.html b/docs/example/events/index.html index 67ad99fe..a5008b89 100644 --- a/docs/example/events/index.html +++ b/docs/example/events/index.html @@ -5,7 +5,7 @@ Events | React Sigma - + diff --git a/docs/example/external_state/index.html b/docs/example/external_state/index.html index ffd7636e..7468b10e 100644 --- a/docs/example/external_state/index.html +++ b/docs/example/external_state/index.html @@ -5,7 +5,7 @@ External State | React Sigma - + diff --git a/docs/example/layouts/index.html b/docs/example/layouts/index.html index 7bb872a5..2a756495 100644 --- a/docs/example/layouts/index.html +++ b/docs/example/layouts/index.html @@ -5,7 +5,7 @@ Layouts | React Sigma - + diff --git a/docs/example/load-graph/index.html b/docs/example/load-graph/index.html index d0b49e18..127e2a4c 100644 --- a/docs/example/load-graph/index.html +++ b/docs/example/load-graph/index.html @@ -5,7 +5,7 @@ Load a graph | React Sigma - + diff --git a/docs/faq/index.html b/docs/faq/index.html index f2bdc558..8882f891 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -5,7 +5,7 @@ Frequently Asked Questions | React Sigma - + diff --git a/docs/start-installation/index.html b/docs/start-installation/index.html index bc4959d3..bfb6d80c 100644 --- a/docs/start-installation/index.html +++ b/docs/start-installation/index.html @@ -5,7 +5,7 @@ Installation | React Sigma - + diff --git a/docs/start-introduction/index.html b/docs/start-introduction/index.html index 78b484dc..450201bb 100644 --- a/docs/start-introduction/index.html +++ b/docs/start-introduction/index.html @@ -5,7 +5,7 @@ Introduction | React Sigma - + diff --git a/docs/start-setup/index.html b/docs/start-setup/index.html index ef567e82..e1145d87 100644 --- a/docs/start-setup/index.html +++ b/docs/start-setup/index.html @@ -5,7 +5,7 @@ Setup | React Sigma - + diff --git a/index.html b/index.html index 29f9e43b..2e5ac238 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ React Sigma | React Sigma - + diff --git a/storybook/project.json b/storybook/project.json index 8b826a63..35de527d 100644 --- a/storybook/project.json +++ b/storybook/project.json @@ -1 +1 @@ -{"generatedAt":1721904605473,"hasCustomBabel":false,"hasCustomWebpack":false,"hasStaticDirs":true,"hasStorybookEslint":false,"refCount":0,"monorepo":"Lerna","packageManager":{"type":"npm","version":"10.7.0"},"typescriptOptions":{"check":true},"preview":{"usesGlobals":false},"framework":{"name":"@storybook/react-vite","options":{}},"builder":"@storybook/builder-vite","renderer":"@storybook/react","language":"javascript","storybookPackages":{},"addons":{"@storybook/addon-links":{"version":"8.0.5"},"@storybook/addon-essentials":{"version":"8.0.5"},"@storybook/addon-interactions":{"version":"8.0.5"},"@storybook/addon-storysource":{"version":"8.0.5"}}} +{"generatedAt":1721905059149,"hasCustomBabel":false,"hasCustomWebpack":false,"hasStaticDirs":true,"hasStorybookEslint":false,"refCount":0,"monorepo":"Lerna","packageManager":{"type":"npm","version":"10.7.0"},"typescriptOptions":{"check":true},"preview":{"usesGlobals":false},"framework":{"name":"@storybook/react-vite","options":{}},"builder":"@storybook/builder-vite","renderer":"@storybook/react","language":"javascript","storybookPackages":{},"addons":{"@storybook/addon-links":{"version":"8.0.5"},"@storybook/addon-essentials":{"version":"8.0.5"},"@storybook/addon-interactions":{"version":"8.0.5"},"@storybook/addon-storysource":{"version":"8.0.5"}}}