diff --git a/404.html b/404.html index ade84203..2ae61255 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | React Sigma - + diff --git a/assets/js/09a6fb8d.0dea65f9.js b/assets/js/09a6fb8d.115640f5.js similarity index 97% rename from assets/js/09a6fb8d.0dea65f9.js rename to assets/js/09a6fb8d.115640f5.js index 0daa102f..cda228a2 100644 --- a/assets/js/09a6fb8d.0dea65f9.js +++ b/assets/js/09a6fb8d.115640f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7919],{5733:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=r(1085),t=r(1184);const o={},i="Type Alias: LayoutWorkerHook()",l={id:"api/layout-core/type-aliases/LayoutWorkerHook",title:"Type Alias: LayoutWorkerHook()\\",description:"LayoutWorkerHook\\: (settings) => object",source:"@site/docs/api/layout-core/type-aliases/LayoutWorkerHook.md",sourceDirName:"api/layout-core/type-aliases",slug:"/api/layout-core/type-aliases/LayoutWorkerHook",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/type-aliases/LayoutWorkerHook.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Type Alias: LayoutHook()\\",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook"},next:{title:"@react-sigma/layout-force",permalink:"/react-sigma/docs/api/layout-force/"}},a={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"type-alias-layoutworkerhookt",children:"Type Alias: LayoutWorkerHook()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"LayoutWorkerHook"}),"<",(0,n.jsx)(s.code,{children:"T"}),">: (",(0,n.jsx)(s.code,{children:"settings"}),") => ",(0,n.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"T"})]}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"settings"}),": ",(0,n.jsx)(s.code,{children:"T"})]}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"object"})}),"\n",(0,n.jsx)(s.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"isRunning"}),": ",(0,n.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"kill"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"start"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h3,{id:"stop",children:"stop()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"stop"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/useWorkerLayoutFactory.ts#L6",children:"useWorkerLayoutFactory.ts:6"})})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1184:(e,s,r)=>{r.d(s,{R:()=>i,x:()=>l});var n=r(4041);const t={},o=n.createContext(t);function i(e){const s=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7919],{5733:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=r(1085),t=r(1184);const o={},i="Type Alias: LayoutWorkerHook()",l={id:"api/layout-core/type-aliases/LayoutWorkerHook",title:"Type Alias: LayoutWorkerHook()\\",description:"LayoutWorkerHook\\: (settings) => object",source:"@site/docs/api/layout-core/type-aliases/LayoutWorkerHook.md",sourceDirName:"api/layout-core/type-aliases",slug:"/api/layout-core/type-aliases/LayoutWorkerHook",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/type-aliases/LayoutWorkerHook.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Type Alias: LayoutHook()\\",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook"},next:{title:"@react-sigma/layout-force",permalink:"/react-sigma/docs/api/layout-force/"}},a={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"type-alias-layoutworkerhookt",children:"Type Alias: LayoutWorkerHook()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"LayoutWorkerHook"}),"<",(0,n.jsx)(s.code,{children:"T"}),">: (",(0,n.jsx)(s.code,{children:"settings"}),") => ",(0,n.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"T"})]}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"settings"}),": ",(0,n.jsx)(s.code,{children:"T"})]}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"object"})}),"\n",(0,n.jsx)(s.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"isRunning"}),": ",(0,n.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"kill"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"start"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h3,{id:"stop",children:"stop()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"stop"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/useWorkerLayoutFactory.ts#L6",children:"useWorkerLayoutFactory.ts:6"})})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1184:(e,s,r)=>{r.d(s,{R:()=>i,x:()=>l});var n=r(4041);const t={},o=n.createContext(t);function i(e){const s=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0abc1b57.d6f4430a.js b/assets/js/0abc1b57.99454050.js similarity index 98% rename from assets/js/0abc1b57.d6f4430a.js rename to assets/js/0abc1b57.99454050.js index 779d69fc..18fa9327 100644 --- a/assets/js/0abc1b57.d6f4430a.js +++ b/assets/js/0abc1b57.99454050.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[958],{3600:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var t=s(1085),o=s(1184);const r={},a="Function: useLayoutNoverlap()",i={id:"api/layout-noverlap/functions/useLayoutNoverlap",title:"Function: useLayoutNoverlap()",description:"useLayoutNoverlap(settings?): object",source:"@site/docs/api/layout-noverlap/functions/useLayoutNoverlap.md",sourceDirName:"api/layout-noverlap/functions",slug:"/api/layout-noverlap/functions/useLayoutNoverlap",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useLayoutNoverlap",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/functions/useLayoutNoverlap.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: LayoutNoverlapControl()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/LayoutNoverlapControl"},next:{title:"Function: useWorkerLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap"}},l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-uselayoutnoverlap",children:"Function: useLayoutNoverlap()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"useLayoutNoverlap"}),"(",(0,t.jsx)(n.code,{children:"settings"}),"?): ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["React hook that helps you to manage ",(0,t.jsx)(n.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutNoverlap(...);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"settings?"}),": ",(0,t.jsx)(n.code,{children:"NoverlapLayoutParameters"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h3,{id:"assign",children:"assign()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"assign"}),": () => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h3,{id:"positions",children:"positions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"positions"}),": () => ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-noverlap/src/useLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useLayoutNoverlap.ts:13"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>i});var t=s(4041);const o={},r=t.createContext(o);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(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([[958],{3600:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var t=s(1085),o=s(1184);const r={},a="Function: useLayoutNoverlap()",i={id:"api/layout-noverlap/functions/useLayoutNoverlap",title:"Function: useLayoutNoverlap()",description:"useLayoutNoverlap(settings?): object",source:"@site/docs/api/layout-noverlap/functions/useLayoutNoverlap.md",sourceDirName:"api/layout-noverlap/functions",slug:"/api/layout-noverlap/functions/useLayoutNoverlap",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useLayoutNoverlap",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/functions/useLayoutNoverlap.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: LayoutNoverlapControl()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/LayoutNoverlapControl"},next:{title:"Function: useWorkerLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap"}},l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-uselayoutnoverlap",children:"Function: useLayoutNoverlap()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"useLayoutNoverlap"}),"(",(0,t.jsx)(n.code,{children:"settings"}),"?): ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["React hook that helps you to manage ",(0,t.jsx)(n.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutNoverlap(...);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"settings?"}),": ",(0,t.jsx)(n.code,{children:"NoverlapLayoutParameters"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h3,{id:"assign",children:"assign()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"assign"}),": () => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h3,{id:"positions",children:"positions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"positions"}),": () => ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-noverlap/src/useLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useLayoutNoverlap.ts:13"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>i});var t=s(4041);const o={},r=t.createContext(o);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/127e2a23.7166b7c1.js b/assets/js/127e2a23.f62b07eb.js similarity index 98% rename from assets/js/127e2a23.7166b7c1.js rename to assets/js/127e2a23.f62b07eb.js index 575922d2..5d6a3cf0 100644 --- a/assets/js/127e2a23.7166b7c1.js +++ b/assets/js/127e2a23.f62b07eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1244],{6804:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var n=t(1085),r=t(1184);const a={},s="Function: LayoutNoverlapControl()",l={id:"api/layout-noverlap/functions/LayoutNoverlapControl",title:"Function: LayoutNoverlapControl()",description:"LayoutNoverlapControl(props, context?): ReactNode",source:"@site/docs/api/layout-noverlap/functions/LayoutNoverlapControl.md",sourceDirName:"api/layout-noverlap/functions",slug:"/api/layout-noverlap/functions/LayoutNoverlapControl",permalink:"/react-sigma/docs/api/layout-noverlap/functions/LayoutNoverlapControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/functions/LayoutNoverlapControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-noverlap",permalink:"/react-sigma/docs/api/layout-noverlap/"},next:{title:"Function: useLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useLayoutNoverlap"}},c={},i=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"function-layoutnoverlapcontrol",children:"Function: LayoutNoverlapControl()"}),"\n",(0,n.jsxs)(o.blockquote,{children:["\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"LayoutNoverlapControl"}),"(",(0,n.jsx)(o.code,{children:"props"}),", ",(0,n.jsx)(o.code,{children:"context"}),"?): ",(0,n.jsx)(o.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"props"}),": ",(0,n.jsx)(o.a,{href:"/react-sigma/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",children:(0,n.jsx)(o.code,{children:"LayoutNoverlapControlProps"})})]}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"context?"}),": ",(0,n.jsx)(o.code,{children:"any"})]}),"\n",(0,n.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.code,{children:"ReactNode"})}),"\n",(0,n.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L20",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20"})})]})}function p(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>l});var n=t(4041);const r={},a=n.createContext(r);function s(e){const o=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function l(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(a.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1244],{6804:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var n=t(1085),r=t(1184);const a={},s="Function: LayoutNoverlapControl()",l={id:"api/layout-noverlap/functions/LayoutNoverlapControl",title:"Function: LayoutNoverlapControl()",description:"LayoutNoverlapControl(props, context?): ReactNode",source:"@site/docs/api/layout-noverlap/functions/LayoutNoverlapControl.md",sourceDirName:"api/layout-noverlap/functions",slug:"/api/layout-noverlap/functions/LayoutNoverlapControl",permalink:"/react-sigma/docs/api/layout-noverlap/functions/LayoutNoverlapControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/functions/LayoutNoverlapControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-noverlap",permalink:"/react-sigma/docs/api/layout-noverlap/"},next:{title:"Function: useLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useLayoutNoverlap"}},c={},i=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"function-layoutnoverlapcontrol",children:"Function: LayoutNoverlapControl()"}),"\n",(0,n.jsxs)(o.blockquote,{children:["\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"LayoutNoverlapControl"}),"(",(0,n.jsx)(o.code,{children:"props"}),", ",(0,n.jsx)(o.code,{children:"context"}),"?): ",(0,n.jsx)(o.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"props"}),": ",(0,n.jsx)(o.a,{href:"/react-sigma/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",children:(0,n.jsx)(o.code,{children:"LayoutNoverlapControlProps"})})]}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"context?"}),": ",(0,n.jsx)(o.code,{children:"any"})]}),"\n",(0,n.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.code,{children:"ReactNode"})}),"\n",(0,n.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L20",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:20"})})]})}function p(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>l});var n=t(4041);const r={},a=n.createContext(r);function s(e){const o=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function l(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(a.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/177d4b79.e9ff814d.js b/assets/js/177d4b79.a8e93bcb.js similarity index 98% rename from assets/js/177d4b79.e9ff814d.js rename to assets/js/177d4b79.a8e93bcb.js index a70fd61c..a9897637 100644 --- a/assets/js/177d4b79.e9ff814d.js +++ b/assets/js/177d4b79.a8e93bcb.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[8508],{7102:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var t=o(1085),r=o(1184);const s={},i="Function: ControlsContainer()",c={id:"api/core/functions/ControlsContainer",title:"Function: ControlsContainer()",description:"ControlsContainer(props, context?): ReactNode",source:"@site/docs/api/core/functions/ControlsContainer.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/ControlsContainer",permalink:"/react-sigma/docs/api/core/functions/ControlsContainer",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/ControlsContainer.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/core",permalink:"/react-sigma/docs/api/core/"},next:{title:"Function: FullScreenControl()",permalink:"/react-sigma/docs/api/core/functions/FullScreenControl"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-controlscontainer",children:"Function: ControlsContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"ControlsContainer"}),"(",(0,t.jsx)(e.code,{children:"props"}),", ",(0,t.jsx)(e.code,{children:"context"}),"?): ",(0,t.jsx)(e.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,t.jsxs)(e.p,{children:["The ",(0,t.jsx)(e.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)(e.code,{children:"react-sigma-controls"}),"."]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-jsx",children:'\n \n \n \n\n'})}),"\n",(0,t.jsx)(e.p,{children:"See [[ControlsContainerProps]] for more information."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"props"}),": ",(0,t.jsx)(e.a,{href:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",children:(0,t.jsx)(e.code,{children:"ControlsContainerProps"})})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"context?"}),": ",(0,t.jsx)(e.code,{children:"any"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ControlsContainer.tsx#L44",children:"packages/core/src/components/controls/ControlsContainer.tsx:44"})})]})}function p(n={}){const{wrapper:e}={...(0,r.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}},1184:(n,e,o)=>{o.d(e,{R:()=>i,x:()=>c});var t=o(4041);const r={},s=t.createContext(r);function i(n){const e=t.useContext(s);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:i(n.components),t.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[8508],{7102:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var t=o(1085),r=o(1184);const s={},i="Function: ControlsContainer()",c={id:"api/core/functions/ControlsContainer",title:"Function: ControlsContainer()",description:"ControlsContainer(props, context?): ReactNode",source:"@site/docs/api/core/functions/ControlsContainer.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/ControlsContainer",permalink:"/react-sigma/docs/api/core/functions/ControlsContainer",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/ControlsContainer.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/core",permalink:"/react-sigma/docs/api/core/"},next:{title:"Function: FullScreenControl()",permalink:"/react-sigma/docs/api/core/functions/FullScreenControl"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-controlscontainer",children:"Function: ControlsContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"ControlsContainer"}),"(",(0,t.jsx)(e.code,{children:"props"}),", ",(0,t.jsx)(e.code,{children:"context"}),"?): ",(0,t.jsx)(e.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,t.jsxs)(e.p,{children:["The ",(0,t.jsx)(e.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)(e.code,{children:"react-sigma-controls"}),"."]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-jsx",children:'\n \n \n \n\n'})}),"\n",(0,t.jsx)(e.p,{children:"See [[ControlsContainerProps]] for more information."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"props"}),": ",(0,t.jsx)(e.a,{href:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps",children:(0,t.jsx)(e.code,{children:"ControlsContainerProps"})})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"context?"}),": ",(0,t.jsx)(e.code,{children:"any"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ControlsContainer.tsx#L44",children:"packages/core/src/components/controls/ControlsContainer.tsx:44"})})]})}function p(n={}){const{wrapper:e}={...(0,r.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}},1184:(n,e,o)=>{o.d(e,{R:()=>i,x:()=>c});var t=o(4041);const r={},s=t.createContext(r);function i(n){const e=t.useContext(s);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:i(n.components),t.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/23db31aa.52cbdeff.js b/assets/js/23db31aa.cd254b13.js similarity index 96% rename from assets/js/23db31aa.52cbdeff.js rename to assets/js/23db31aa.cd254b13.js index d480bc70..98063bbd 100644 --- a/assets/js/23db31aa.52cbdeff.js +++ b/assets/js/23db31aa.cd254b13.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[4970],{5181:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>a,frontMatter:()=>t,metadata:()=>l,toc:()=>u});var c=s(1085),r=s(1184);const t={},i="Function: useFullScreen()",l={id:"api/core/functions/useFullScreen",title:"Function: useFullScreen()",description:"useFullScreen(container?): object",source:"@site/docs/api/core/functions/useFullScreen.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useFullScreen",permalink:"/react-sigma/docs/api/core/functions/useFullScreen",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useFullScreen.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useCamera()",permalink:"/react-sigma/docs/api/core/functions/useCamera"},next:{title:"Function: useLoadGraph()",permalink:"/react-sigma/docs/api/core/functions/useLoadGraph"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isFullScreen",id:"isfullscreen",level:3},{value:"toggle()",id:"toggle",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-usefullscreen",children:"Function: useFullScreen()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"useFullScreen"}),"(",(0,c.jsx)(n.code,{children:"container"}),"?): ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"React hook that helps you to set graph in fullmode."}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-typescript",children:"const {toggle, isFullScreen} = useFullscreen();\n"})}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"container?"}),": ",(0,c.jsx)(n.code,{children:"null"})," | ",(0,c.jsx)(n.code,{children:"HTMLElement"})]}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"object"})}),"\n",(0,c.jsx)(n.h3,{id:"isfullscreen",children:"isFullScreen"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"isFullScreen"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h3,{id:"toggle",children:"toggle()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"toggle"}),": () => ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/useFullScreen.ts#L22",children:"packages/core/src/hooks/useFullScreen.ts:22"})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>l});var c=s(4041);const r={},t=c.createContext(r);function i(e){const n=c.useContext(t);return c.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(r):e.components||r:i(e.components),c.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([[4970],{5181:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>a,frontMatter:()=>t,metadata:()=>l,toc:()=>u});var c=s(1085),r=s(1184);const t={},i="Function: useFullScreen()",l={id:"api/core/functions/useFullScreen",title:"Function: useFullScreen()",description:"useFullScreen(container?): object",source:"@site/docs/api/core/functions/useFullScreen.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useFullScreen",permalink:"/react-sigma/docs/api/core/functions/useFullScreen",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useFullScreen.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useCamera()",permalink:"/react-sigma/docs/api/core/functions/useCamera"},next:{title:"Function: useLoadGraph()",permalink:"/react-sigma/docs/api/core/functions/useLoadGraph"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isFullScreen",id:"isfullscreen",level:3},{value:"toggle()",id:"toggle",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-usefullscreen",children:"Function: useFullScreen()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"useFullScreen"}),"(",(0,c.jsx)(n.code,{children:"container"}),"?): ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"React hook that helps you to set graph in fullmode."}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-typescript",children:"const {toggle, isFullScreen} = useFullscreen();\n"})}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"container?"}),": ",(0,c.jsx)(n.code,{children:"null"})," | ",(0,c.jsx)(n.code,{children:"HTMLElement"})]}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"object"})}),"\n",(0,c.jsx)(n.h3,{id:"isfullscreen",children:"isFullScreen"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"isFullScreen"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h3,{id:"toggle",children:"toggle()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"toggle"}),": () => ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/useFullScreen.ts#L22",children:"packages/core/src/hooks/useFullScreen.ts:22"})})]})}function a(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>l});var c=s(4041);const r={},t=c.createContext(r);function i(e){const n=c.useContext(t);return c.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(r):e.components||r:i(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28066f65.ecf49010.js b/assets/js/28066f65.3cd23b36.js similarity index 98% rename from assets/js/28066f65.ecf49010.js rename to assets/js/28066f65.3cd23b36.js index 266e6009..935ec683 100644 --- a/assets/js/28066f65.ecf49010.js +++ b/assets/js/28066f65.3cd23b36.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6224],{7156:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var n=t(1085),r=t(1184);const c={},s="Function: LayoutForceControl()",a={id:"api/layout-force/functions/LayoutForceControl",title:"Function: LayoutForceControl()",description:"LayoutForceControl(props, context?): ReactNode",source:"@site/docs/api/layout-force/functions/LayoutForceControl.md",sourceDirName:"api/layout-force/functions",slug:"/api/layout-force/functions/LayoutForceControl",permalink:"/react-sigma/docs/api/layout-force/functions/LayoutForceControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/functions/LayoutForceControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-force",permalink:"/react-sigma/docs/api/layout-force/"},next:{title:"Function: useLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useLayoutForce"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"function-layoutforcecontrol",children:"Function: LayoutForceControl()"}),"\n",(0,n.jsxs)(o.blockquote,{children:["\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"LayoutForceControl"}),"(",(0,n.jsx)(o.code,{children:"props"}),", ",(0,n.jsx)(o.code,{children:"context"}),"?): ",(0,n.jsx)(o.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,n.jsx)(o.p,{children:"Component that display a button to start/stop the layout."}),"\n",(0,n.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"props"}),": ",(0,n.jsx)(o.a,{href:"/react-sigma/docs/api/layout-force/type-aliases/LayoutForceControlProps",children:(0,n.jsx)(o.code,{children:"LayoutForceControlProps"})})]}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"context?"}),": ",(0,n.jsx)(o.code,{children:"any"})]}),"\n",(0,n.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.code,{children:"ReactNode"})}),"\n",(0,n.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-force/src/LayoutForceControl.tsx#L22",children:"packages/layout-force/src/LayoutForceControl.tsx:22"})})]})}function d(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>a});var n=t(4041);const r={},c=n.createContext(r);function s(e){const o=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(c.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6224],{7156:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var n=t(1085),r=t(1184);const c={},s="Function: LayoutForceControl()",a={id:"api/layout-force/functions/LayoutForceControl",title:"Function: LayoutForceControl()",description:"LayoutForceControl(props, context?): ReactNode",source:"@site/docs/api/layout-force/functions/LayoutForceControl.md",sourceDirName:"api/layout-force/functions",slug:"/api/layout-force/functions/LayoutForceControl",permalink:"/react-sigma/docs/api/layout-force/functions/LayoutForceControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/functions/LayoutForceControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-force",permalink:"/react-sigma/docs/api/layout-force/"},next:{title:"Function: useLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useLayoutForce"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"function-layoutforcecontrol",children:"Function: LayoutForceControl()"}),"\n",(0,n.jsxs)(o.blockquote,{children:["\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.strong,{children:"LayoutForceControl"}),"(",(0,n.jsx)(o.code,{children:"props"}),", ",(0,n.jsx)(o.code,{children:"context"}),"?): ",(0,n.jsx)(o.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,n.jsx)(o.p,{children:"Component that display a button to start/stop the layout."}),"\n",(0,n.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"props"}),": ",(0,n.jsx)(o.a,{href:"/react-sigma/docs/api/layout-force/type-aliases/LayoutForceControlProps",children:(0,n.jsx)(o.code,{children:"LayoutForceControlProps"})})]}),"\n",(0,n.jsxs)(o.p,{children:["\u2022 ",(0,n.jsx)(o.strong,{children:"context?"}),": ",(0,n.jsx)(o.code,{children:"any"})]}),"\n",(0,n.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.code,{children:"ReactNode"})}),"\n",(0,n.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(o.p,{children:(0,n.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-force/src/LayoutForceControl.tsx#L22",children:"packages/layout-force/src/LayoutForceControl.tsx:22"})})]})}function d(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>a});var n=t(4041);const r={},c=n.createContext(r);function s(e){const o=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(c.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28a50278.b66247ab.js b/assets/js/28a50278.0c9c3659.js similarity index 93% rename from assets/js/28a50278.b66247ab.js rename to assets/js/28a50278.0c9c3659.js index 0627e14c..434d2b0e 100644 --- a/assets/js/28a50278.b66247ab.js +++ b/assets/js/28a50278.0c9c3659.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7784],{4006:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=o(1085),r=o(1184);const i={},t="Interface: ZoomControlProps",c={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/ZoomControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: SigmaContextInterface\\",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"},next:{title:"Type Alias: EventHandlers",permalink:"/react-sigma/docs/api/core/type-aliases/EventHandlers"}},l={},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:"reset",id:"reset",level:4},{value:"zoomIn",id:"zoomin",level:4},{value:"zoomOut",id:"zoomout",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",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-zoomcontrolprops",children:"Interface: ZoomControlProps"}),"\n",(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"ZoomControl"})," component"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"animationduration",children:"animationDuration?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"animationDuration"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of ms for the zoom animation (default is 200ms)"}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ZoomControl.tsx#L27",children:"packages/core/src/components/controls/ZoomControl.tsx:27"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"children",children:"children?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": [",(0,s.jsx)(n.code,{children:"Element"}),", ",(0,s.jsx)(n.code,{children:"Element"}),", ",(0,s.jsx)(n.code,{children:"Element"}),"]"]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ZoomControl.tsx#L41",children:"packages/core/src/components/controls/ZoomControl.tsx:41"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML class that will be added to all div button wrapper"}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ZoomControl.tsx#L17",children:"packages/core/src/components/controls/ZoomControl.tsx:17"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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:"reset",children:"reset"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reset"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"zoomin",children:"zoomIn"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"zoomIn"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"zoomout",children:"zoomOut"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"zoomOut"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ZoomControl.tsx#L47",children:"packages/core/src/components/controls/ZoomControl.tsx:47"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style that will be added to all div button wrapper"}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ZoomControl.tsx#L22",children:"packages/core/src/components/controls/ZoomControl.tsx:22"})})]})}function h(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([[7784],{4006:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=o(1085),r=o(1184);const i={},t="Interface: ZoomControlProps",c={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/ZoomControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: SigmaContextInterface\\",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"},next:{title:"Type Alias: EventHandlers",permalink:"/react-sigma/docs/api/core/type-aliases/EventHandlers"}},l={},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:"reset",id:"reset",level:4},{value:"zoomIn",id:"zoomin",level:4},{value:"zoomOut",id:"zoomout",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",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-zoomcontrolprops",children:"Interface: ZoomControlProps"}),"\n",(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"ZoomControl"})," component"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"animationduration",children:"animationDuration?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"animationDuration"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of ms for the zoom animation (default is 200ms)"}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ZoomControl.tsx#L27",children:"packages/core/src/components/controls/ZoomControl.tsx:27"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"children",children:"children?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": [",(0,s.jsx)(n.code,{children:"Element"}),", ",(0,s.jsx)(n.code,{children:"Element"}),", ",(0,s.jsx)(n.code,{children:"Element"}),"]"]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ZoomControl.tsx#L41",children:"packages/core/src/components/controls/ZoomControl.tsx:41"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML class that will be added to all div button wrapper"}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ZoomControl.tsx#L17",children:"packages/core/src/components/controls/ZoomControl.tsx:17"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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:"reset",children:"reset"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reset"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"zoomin",children:"zoomIn"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"zoomIn"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"zoomout",children:"zoomOut"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"zoomOut"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ZoomControl.tsx#L47",children:"packages/core/src/components/controls/ZoomControl.tsx:47"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style that will be added to all div button wrapper"}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ZoomControl.tsx#L22",children:"packages/core/src/components/controls/ZoomControl.tsx:22"})})]})}function h(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/32dd47bd.5b1c869f.js b/assets/js/32dd47bd.a3a0731a.js similarity index 94% rename from assets/js/32dd47bd.5b1c869f.js rename to assets/js/32dd47bd.a3a0731a.js index 1b40cf61..d477a1a9 100644 --- a/assets/js/32dd47bd.5b1c869f.js +++ b/assets/js/32dd47bd.a3a0731a.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2765],{7205:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>d});var s=r(1085),c=r(1184);const o={},i="Interface: SearchControlProps",t={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/SearchControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps"},next:{title:"Interface: 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:"placeholder",id:"placeholder",level:4},{value:"text",id:"text",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",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-searchcontrolprops",children:"Interface: SearchControlProps"}),"\n",(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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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:"placeholder",children:"placeholder"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"placeholder"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"text",children:"text"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"text"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/SearchControl.tsx#L28",children:"packages/core/src/components/controls/SearchControl.tsx:28"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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:()=>i,x:()=>t});var s=r(4041);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2765],{7205:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>d});var s=r(1085),c=r(1184);const o={},i="Interface: SearchControlProps",t={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/SearchControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: FullScreenControlProps",permalink:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps"},next:{title:"Interface: 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:"placeholder",id:"placeholder",level:4},{value:"text",id:"text",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",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-searchcontrolprops",children:"Interface: SearchControlProps"}),"\n",(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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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:"placeholder",children:"placeholder"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"placeholder"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"text",children:"text"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"text"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/SearchControl.tsx#L28",children:"packages/core/src/components/controls/SearchControl.tsx:28"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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:()=>i,x:()=>t});var s=r(4041);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/36d28def.58c862cf.js b/assets/js/36d28def.7bc4a68d.js similarity index 96% rename from assets/js/36d28def.58c862cf.js rename to assets/js/36d28def.7bc4a68d.js index 9950a952..05f66360 100644 --- a/assets/js/36d28def.58c862cf.js +++ b/assets/js/36d28def.7bc4a68d.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1403],{5281:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(1085),i=s(1184);const c={},r="Function: useSigma()",o={id:"api/core/functions/useSigma",title:"Function: useSigma()",description:"useSigma\\(): Sigma\\",source:"@site/docs/api/core/functions/useSigma.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useSigma",permalink:"/react-sigma/docs/api/core/functions/useSigma",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useSigma.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useSetSettings()",permalink:"/react-sigma/docs/api/core/functions/useSetSettings"},next:{title:"Function: useSigmaContext()",permalink:"/react-sigma/docs/api/core/functions/useSigmaContext"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-usesigma",children:"Function: useSigma()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(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"]}),"\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.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"N"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"E"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"G"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",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.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/useSigma.ts#L14",children:"packages/core/src/hooks/useSigma.ts:14"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(4041);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1403],{5281:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(1085),i=s(1184);const c={},r="Function: useSigma()",o={id:"api/core/functions/useSigma",title:"Function: useSigma()",description:"useSigma\\(): Sigma\\",source:"@site/docs/api/core/functions/useSigma.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useSigma",permalink:"/react-sigma/docs/api/core/functions/useSigma",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useSigma.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useSetSettings()",permalink:"/react-sigma/docs/api/core/functions/useSetSettings"},next:{title:"Function: useSigmaContext()",permalink:"/react-sigma/docs/api/core/functions/useSigmaContext"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-usesigma",children:"Function: useSigma()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(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"]}),"\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.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"N"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"E"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"G"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",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.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/useSigma.ts#L14",children:"packages/core/src/hooks/useSigma.ts:14"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(4041);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/406179f6.7646aabb.js b/assets/js/406179f6.715e34f1.js similarity index 98% rename from assets/js/406179f6.7646aabb.js rename to assets/js/406179f6.715e34f1.js index 539cfe81..59a609a3 100644 --- a/assets/js/406179f6.7646aabb.js +++ b/assets/js/406179f6.715e34f1.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1284],{1950:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=r(1085),t=r(1184);const c={},i="Function: useLoadGraph()",o={id:"api/core/functions/useLoadGraph",title:"Function: useLoadGraph()",description:"useLoadGraph\\(): (graph, clear?) => void",source:"@site/docs/api/core/functions/useLoadGraph.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useLoadGraph",permalink:"/react-sigma/docs/api/core/functions/useLoadGraph",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useLoadGraph.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useFullScreen()",permalink:"/react-sigma/docs/api/core/functions/useFullScreen"},next:{title:"Function: useRegisterEvents()",permalink:"/react-sigma/docs/api/core/functions/useRegisterEvents"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-useloadgraph",children:"Function: useLoadGraph()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useLoadGraph"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">(): (",(0,s.jsx)(n.code,{children:"graph"}),", ",(0,s.jsx)(n.code,{children:"clear"}),"?) => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.code,{children:"clear"})," to false."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"N"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"E"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"G"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Function"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"graph"}),": ",(0,s.jsx)(n.code,{children:"Graph"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"clear?"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/useLoadGraph.ts#L21",children:"packages/core/src/hooks/useLoadGraph.ts:21"})})]})}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,r)=>{r.d(n,{R:()=>i,x:()=>o});var s=r(4041);const t={},c=s.createContext(t);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1284],{1950:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=r(1085),t=r(1184);const c={},i="Function: useLoadGraph()",o={id:"api/core/functions/useLoadGraph",title:"Function: useLoadGraph()",description:"useLoadGraph\\(): (graph, clear?) => void",source:"@site/docs/api/core/functions/useLoadGraph.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useLoadGraph",permalink:"/react-sigma/docs/api/core/functions/useLoadGraph",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useLoadGraph.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useFullScreen()",permalink:"/react-sigma/docs/api/core/functions/useFullScreen"},next:{title:"Function: useRegisterEvents()",permalink:"/react-sigma/docs/api/core/functions/useRegisterEvents"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-useloadgraph",children:"Function: useLoadGraph()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useLoadGraph"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">(): (",(0,s.jsx)(n.code,{children:"graph"}),", ",(0,s.jsx)(n.code,{children:"clear"}),"?) => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.code,{children:"clear"})," to false."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"N"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"E"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"G"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Function"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"graph"}),": ",(0,s.jsx)(n.code,{children:"Graph"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"clear?"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/useLoadGraph.ts#L21",children:"packages/core/src/hooks/useLoadGraph.ts:21"})})]})}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,r)=>{r.d(n,{R:()=>i,x:()=>o});var s=r(4041);const t={},c=s.createContext(t);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/47a287a0.1c9fe0b8.js b/assets/js/47a287a0.3d62984a.js similarity index 92% rename from assets/js/47a287a0.1c9fe0b8.js rename to assets/js/47a287a0.3d62984a.js index 5169eb04..b370e78d 100644 --- a/assets/js/47a287a0.1c9fe0b8.js +++ b/assets/js/47a287a0.3d62984a.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5146],{6048:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var s=r(1085),c=r(1184);const l={},o="Interface: FullScreenControlProps",i={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/FullScreenControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"},next:{title:"Interface: SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"}},t={},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:"enter",id:"enter",level:4},{value:"exit",id:"exit",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",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-fullscreencontrolprops",children:"Interface: FullScreenControlProps"}),"\n",(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"FullScreenControl"})," 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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": [",(0,s.jsx)(n.code,{children:"Element"}),", ",(0,s.jsx)(n.code,{children:"Element"}),"]"]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-jsx",children:"\n \n \n\n"})}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L44",children:"packages/core/src/components/controls/FullScreenControl.tsx:44"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L21",children:"packages/core/src/components/controls/FullScreenControl.tsx:21"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"container",children:"container?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"container"}),": ",(0,s.jsx)(n.code,{children:"RefObject"}),"<",(0,s.jsx)(n.code,{children:"HTMLElement"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"If defined, this container will be taken for the fullscreen instead of the sigma one."}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L31",children:"packages/core/src/components/controls/FullScreenControl.tsx:31"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L16",children:"packages/core/src/components/controls/FullScreenControl.tsx:16"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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:"enter",children:"enter"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"enter"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exit",children:"exit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"exit"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L50",children:"packages/core/src/components/controls/FullScreenControl.tsx:50"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L26",children:"packages/core/src/components/controls/FullScreenControl.tsx:26"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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:()=>i});var s=r(4041);const c={},l=s.createContext(c);function o(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.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([[5146],{6048:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var s=r(1085),c=r(1184);const l={},o="Interface: FullScreenControlProps",i={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/FullScreenControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"},next:{title:"Interface: SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"}},t={},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:"enter",id:"enter",level:4},{value:"exit",id:"exit",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",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-fullscreencontrolprops",children:"Interface: FullScreenControlProps"}),"\n",(0,s.jsxs)(n.p,{children:["Properties for ",(0,s.jsx)(n.code,{children:"FullScreenControl"})," 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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": [",(0,s.jsx)(n.code,{children:"Element"}),", ",(0,s.jsx)(n.code,{children:"Element"}),"]"]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-jsx",children:"\n \n \n\n"})}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L44",children:"packages/core/src/components/controls/FullScreenControl.tsx:44"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"classname",children:"className?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L21",children:"packages/core/src/components/controls/FullScreenControl.tsx:21"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"container",children:"container?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"container"}),": ",(0,s.jsx)(n.code,{children:"RefObject"}),"<",(0,s.jsx)(n.code,{children:"HTMLElement"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"If defined, this container will be taken for the fullscreen instead of the sigma one."}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L31",children:"packages/core/src/components/controls/FullScreenControl.tsx:31"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML id"}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L16",children:"packages/core/src/components/controls/FullScreenControl.tsx:16"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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:"enter",children:"enter"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"enter"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exit",children:"exit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"exit"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L50",children:"packages/core/src/components/controls/FullScreenControl.tsx:50"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"style",children:"style?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L26",children:"packages/core/src/components/controls/FullScreenControl.tsx:26"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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:()=>i});var s=r(4041);const c={},l=s.createContext(c);function o(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c3db254.36857124.js b/assets/js/4c3db254.c5192b9c.js similarity index 96% rename from assets/js/4c3db254.36857124.js rename to assets/js/4c3db254.c5192b9c.js index e9805d86..3c3bfeec 100644 --- a/assets/js/4c3db254.36857124.js +++ b/assets/js/4c3db254.c5192b9c.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5618],{5970:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>u});var t=s(1085),o=s(1184);const r={},c="Function: useLayoutForce()",i={id:"api/layout-force/functions/useLayoutForce",title:"Function: useLayoutForce()",description:"useLayoutForce(settings?): object",source:"@site/docs/api/layout-force/functions/useLayoutForce.md",sourceDirName:"api/layout-force/functions",slug:"/api/layout-force/functions/useLayoutForce",permalink:"/react-sigma/docs/api/layout-force/functions/useLayoutForce",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/functions/useLayoutForce.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: LayoutForceControl()",permalink:"/react-sigma/docs/api/layout-force/functions/LayoutForceControl"},next:{title:"Function: useWorkerLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useWorkerLayoutForce"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-uselayoutforce",children:"Function: useLayoutForce()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"useLayoutForce"}),"(",(0,t.jsx)(n.code,{children:"settings"}),"?): ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["React hook that helps you to manage ",(0,t.jsx)(n.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForce(...);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"settings?"}),": ",(0,t.jsx)(n.code,{children:"ForceLayoutParameters"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h3,{id:"assign",children:"assign()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"assign"}),": () => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h3,{id:"positions",children:"positions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"positions"}),": () => ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-force/src/useLayoutForce.ts#L13",children:"packages/layout-force/src/useLayoutForce.ts:13"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>i});var t=s(4041);const o={},r=t.createContext(o);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(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([[5618],{5970:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>u});var t=s(1085),o=s(1184);const r={},c="Function: useLayoutForce()",i={id:"api/layout-force/functions/useLayoutForce",title:"Function: useLayoutForce()",description:"useLayoutForce(settings?): object",source:"@site/docs/api/layout-force/functions/useLayoutForce.md",sourceDirName:"api/layout-force/functions",slug:"/api/layout-force/functions/useLayoutForce",permalink:"/react-sigma/docs/api/layout-force/functions/useLayoutForce",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/functions/useLayoutForce.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: LayoutForceControl()",permalink:"/react-sigma/docs/api/layout-force/functions/LayoutForceControl"},next:{title:"Function: useWorkerLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useWorkerLayoutForce"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-uselayoutforce",children:"Function: useLayoutForce()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"useLayoutForce"}),"(",(0,t.jsx)(n.code,{children:"settings"}),"?): ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["React hook that helps you to manage ",(0,t.jsx)(n.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForce(...);\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"settings?"}),": ",(0,t.jsx)(n.code,{children:"ForceLayoutParameters"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h3,{id:"assign",children:"assign()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"assign"}),": () => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h3,{id:"positions",children:"positions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"positions"}),": () => ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-force/src/useLayoutForce.ts#L13",children:"packages/layout-force/src/useLayoutForce.ts:13"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>i});var t=s(4041);const o={},r=t.createContext(o);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c8499be.30b85404.js b/assets/js/4c8499be.5414d19e.js similarity index 98% rename from assets/js/4c8499be.30b85404.js rename to assets/js/4c8499be.5414d19e.js index 55ced072..5bda912d 100644 --- a/assets/js/4c8499be.30b85404.js +++ b/assets/js/4c8499be.5414d19e.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6725],{5595:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var o=r(1085),n=r(1184);const a={},s="Function: WorkerLayoutControl()",c={id:"api/layout-core/functions/WorkerLayoutControl",title:"Function: WorkerLayoutControl()",description:"WorkerLayoutControl\\(namedParameters): Element",source:"@site/docs/api/layout-core/functions/WorkerLayoutControl.md",sourceDirName:"api/layout-core/functions",slug:"/api/layout-core/functions/WorkerLayoutControl",permalink:"/react-sigma/docs/api/layout-core/functions/WorkerLayoutControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/functions/WorkerLayoutControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-core",permalink:"/react-sigma/docs/api/layout-core/"},next:{title:"Function: useLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useLayoutFactory"}},i={},l=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"function-workerlayoutcontrol",children:"Function: WorkerLayoutControl()"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"WorkerLayoutControl"}),"<",(0,o.jsx)(t.code,{children:"T"}),">(",(0,o.jsx)(t.code,{children:"__namedParameters"}),"): ",(0,o.jsx)(t.code,{children:"Element"})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsxs)(t.p,{children:["\u2022 ",(0,o.jsx)(t.strong,{children:"T"})]}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(t.p,{children:["\u2022 ",(0,o.jsx)(t.strong,{children:"__namedParameters"}),": ",(0,o.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",children:(0,o.jsx)(t.code,{children:"WorkerLayoutControlProps"})}),"<",(0,o.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"Element"})}),"\n",(0,o.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L69",children:"WorkerLayoutControl.tsx:69"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>c});var o=r(4041);const n={},a=o.createContext(n);function s(e){const t=o.useContext(a);return o.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(n):e.components||n:s(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6725],{5595:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var o=r(1085),n=r(1184);const a={},s="Function: WorkerLayoutControl()",c={id:"api/layout-core/functions/WorkerLayoutControl",title:"Function: WorkerLayoutControl()",description:"WorkerLayoutControl\\(namedParameters): Element",source:"@site/docs/api/layout-core/functions/WorkerLayoutControl.md",sourceDirName:"api/layout-core/functions",slug:"/api/layout-core/functions/WorkerLayoutControl",permalink:"/react-sigma/docs/api/layout-core/functions/WorkerLayoutControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/functions/WorkerLayoutControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-core",permalink:"/react-sigma/docs/api/layout-core/"},next:{title:"Function: useLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useLayoutFactory"}},i={},l=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"function-workerlayoutcontrol",children:"Function: WorkerLayoutControl()"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"WorkerLayoutControl"}),"<",(0,o.jsx)(t.code,{children:"T"}),">(",(0,o.jsx)(t.code,{children:"__namedParameters"}),"): ",(0,o.jsx)(t.code,{children:"Element"})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsxs)(t.p,{children:["\u2022 ",(0,o.jsx)(t.strong,{children:"T"})]}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(t.p,{children:["\u2022 ",(0,o.jsx)(t.strong,{children:"__namedParameters"}),": ",(0,o.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps",children:(0,o.jsx)(t.code,{children:"WorkerLayoutControlProps"})}),"<",(0,o.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"Element"})}),"\n",(0,o.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L69",children:"WorkerLayoutControl.tsx:69"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},1184:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>c});var o=r(4041);const n={},a=o.createContext(n);function s(e){const t=o.useContext(a);return o.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(n):e.components||n:s(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d2c4bb1.0aa42569.js b/assets/js/4d2c4bb1.de706d7d.js similarity index 96% rename from assets/js/4d2c4bb1.0aa42569.js rename to assets/js/4d2c4bb1.de706d7d.js index 9837f748..6eedc021 100644 --- a/assets/js/4d2c4bb1.0aa42569.js +++ b/assets/js/4d2c4bb1.de706d7d.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2063],{7107:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var o=t(1085),n=t(1184);const r={},i="Type Alias: LayoutHook()",a={id:"api/layout-core/type-aliases/LayoutHook",title:"Type Alias: LayoutHook()\\",description:"LayoutHook\\: (settings?) => object",source:"@site/docs/api/layout-core/type-aliases/LayoutHook.md",sourceDirName:"api/layout-core/type-aliases",slug:"/api/layout-core/type-aliases/LayoutHook",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/type-aliases/LayoutHook.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: WorkerLayoutControlProps\\",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"},next:{title:"Type Alias: LayoutWorkerHook()\\",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook"}},c={},l=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"type-alias-layouthookt",children:"Type Alias: LayoutHook()"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"LayoutHook"}),"<",(0,o.jsx)(s.code,{children:"T"}),">: (",(0,o.jsx)(s.code,{children:"settings"}),"?) => ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"Generic type for layout hooks."}),"\n",(0,o.jsx)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsxs)(s.p,{children:["\u2022 ",(0,o.jsx)(s.strong,{children:"T"})]}),"\n",(0,o.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(s.p,{children:["\u2022 ",(0,o.jsx)(s.strong,{children:"settings?"}),": ",(0,o.jsx)(s.code,{children:"T"})]}),"\n",(0,o.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.code,{children:"object"})}),"\n",(0,o.jsx)(s.h3,{id:"assign",children:"assign()"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"assign"}),": () => ",(0,o.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"Assign layout node's position into the sigma graph."}),"\n",(0,o.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.code,{children:"void"})}),"\n",(0,o.jsx)(s.h3,{id:"positions",children:"positions()"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"positions"}),": () => ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"Returns a positions map by node key."}),"\n",(0,o.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.code,{children:"object"})}),"\n",(0,o.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/useLayoutFactory.ts#L17",children:"useLayoutFactory.ts:17"})})]})}function u(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>i,x:()=>a});var o=t(4041);const n={},r=o.createContext(n);function i(e){const s=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),o.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2063],{7107:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var o=t(1085),n=t(1184);const r={},i="Type Alias: LayoutHook()",a={id:"api/layout-core/type-aliases/LayoutHook",title:"Type Alias: LayoutHook()\\",description:"LayoutHook\\: (settings?) => object",source:"@site/docs/api/layout-core/type-aliases/LayoutHook.md",sourceDirName:"api/layout-core/type-aliases",slug:"/api/layout-core/type-aliases/LayoutHook",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/type-aliases/LayoutHook.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: WorkerLayoutControlProps\\",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"},next:{title:"Type Alias: LayoutWorkerHook()\\",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook"}},c={},l=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.h1,{id:"type-alias-layouthookt",children:"Type Alias: LayoutHook()"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"LayoutHook"}),"<",(0,o.jsx)(s.code,{children:"T"}),">: (",(0,o.jsx)(s.code,{children:"settings"}),"?) => ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"Generic type for layout hooks."}),"\n",(0,o.jsx)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsxs)(s.p,{children:["\u2022 ",(0,o.jsx)(s.strong,{children:"T"})]}),"\n",(0,o.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(s.p,{children:["\u2022 ",(0,o.jsx)(s.strong,{children:"settings?"}),": ",(0,o.jsx)(s.code,{children:"T"})]}),"\n",(0,o.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.code,{children:"object"})}),"\n",(0,o.jsx)(s.h3,{id:"assign",children:"assign()"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"assign"}),": () => ",(0,o.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"Assign layout node's position into the sigma graph."}),"\n",(0,o.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.code,{children:"void"})}),"\n",(0,o.jsx)(s.h3,{id:"positions",children:"positions()"}),"\n",(0,o.jsxs)(s.blockquote,{children:["\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"positions"}),": () => ",(0,o.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(s.p,{children:"Returns a positions map by node key."}),"\n",(0,o.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.code,{children:"object"})}),"\n",(0,o.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(s.p,{children:(0,o.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/useLayoutFactory.ts#L17",children:"useLayoutFactory.ts:17"})})]})}function u(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>i,x:()=>a});var o=t(4041);const n={},r=o.createContext(n);function i(e){const s=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),o.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/50c0544f.4b397317.js b/assets/js/50c0544f.e545c423.js similarity index 96% rename from assets/js/50c0544f.4b397317.js rename to assets/js/50c0544f.e545c423.js index 6f4cd007..a9cf0514 100644 --- a/assets/js/50c0544f.4b397317.js +++ b/assets/js/50c0544f.e545c423.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1852],{4886:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>n,metadata:()=>a,toc:()=>l});var r=t(1085),s=t(1184);const n={},c="Type Alias: LayoutForceControlProps",a={id:"api/layout-force/type-aliases/LayoutForceControlProps",title:"Type Alias: LayoutForceControlProps",description:'LayoutForceControlProps: Omit\\, "layout" \\| "settings"\\> & object',source:"@site/docs/api/layout-force/type-aliases/LayoutForceControlProps.md",sourceDirName:"api/layout-force/type-aliases",slug:"/api/layout-force/type-aliases/LayoutForceControlProps",permalink:"/react-sigma/docs/api/layout-force/type-aliases/LayoutForceControlProps",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/type-aliases/LayoutForceControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useWorkerLayoutForce"},next:{title:"@react-sigma/layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"}},i={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"settings?",id:"settings",level:3},{value:"Defined in",id:"defined-in",level:2}];function d(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(o.h1,{id:"type-alias-layoutforcecontrolprops",children:"Type Alias: LayoutForceControlProps"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.strong,{children:"LayoutForceControlProps"}),": ",(0,r.jsx)(o.code,{children:"Omit"}),"<",(0,r.jsx)(o.code,{children:"WorkerLayoutControlProps"}),"<",(0,r.jsx)(o.code,{children:"ForceLayoutSupervisorParameters"}),">, ",(0,r.jsx)(o.code,{children:'"layout"'})," | ",(0,r.jsx)(o.code,{children:'"settings"'}),"> & ",(0,r.jsx)(o.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(o.p,{children:["Properties for ",(0,r.jsx)(o.code,{children:"ForceDirectedControl"})," component"]}),"\n",(0,r.jsx)(o.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(o.h3,{id:"settings",children:"settings?"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.code,{children:"optional"})," ",(0,r.jsx)(o.strong,{children:"settings"}),": ",(0,r.jsx)(o.code,{children:"ForceLayoutSupervisorParameters"})]}),"\n"]}),"\n",(0,r.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(o.p,{children:(0,r.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-force/src/LayoutForceControl.tsx#L10",children:"packages/layout-force/src/LayoutForceControl.tsx:10"})})]})}function u(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,r.jsx)(o,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>c,x:()=>a});var r=t(4041);const s={},n=r.createContext(s);function c(e){const o=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(n.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1852],{4886:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>n,metadata:()=>a,toc:()=>l});var r=t(1085),s=t(1184);const n={},c="Type Alias: LayoutForceControlProps",a={id:"api/layout-force/type-aliases/LayoutForceControlProps",title:"Type Alias: LayoutForceControlProps",description:'LayoutForceControlProps: Omit\\, "layout" \\| "settings"\\> & object',source:"@site/docs/api/layout-force/type-aliases/LayoutForceControlProps.md",sourceDirName:"api/layout-force/type-aliases",slug:"/api/layout-force/type-aliases/LayoutForceControlProps",permalink:"/react-sigma/docs/api/layout-force/type-aliases/LayoutForceControlProps",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/type-aliases/LayoutForceControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useWorkerLayoutForce"},next:{title:"@react-sigma/layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"}},i={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"settings?",id:"settings",level:3},{value:"Defined in",id:"defined-in",level:2}];function d(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(o.h1,{id:"type-alias-layoutforcecontrolprops",children:"Type Alias: LayoutForceControlProps"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.strong,{children:"LayoutForceControlProps"}),": ",(0,r.jsx)(o.code,{children:"Omit"}),"<",(0,r.jsx)(o.code,{children:"WorkerLayoutControlProps"}),"<",(0,r.jsx)(o.code,{children:"ForceLayoutSupervisorParameters"}),">, ",(0,r.jsx)(o.code,{children:'"layout"'})," | ",(0,r.jsx)(o.code,{children:'"settings"'}),"> & ",(0,r.jsx)(o.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(o.p,{children:["Properties for ",(0,r.jsx)(o.code,{children:"ForceDirectedControl"})," component"]}),"\n",(0,r.jsx)(o.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(o.h3,{id:"settings",children:"settings?"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.code,{children:"optional"})," ",(0,r.jsx)(o.strong,{children:"settings"}),": ",(0,r.jsx)(o.code,{children:"ForceLayoutSupervisorParameters"})]}),"\n"]}),"\n",(0,r.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(o.p,{children:(0,r.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-force/src/LayoutForceControl.tsx#L10",children:"packages/layout-force/src/LayoutForceControl.tsx:10"})})]})}function u(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,r.jsx)(o,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>c,x:()=>a});var r=t(4041);const s={},n=r.createContext(s);function c(e){const o=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(n.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b5d3e9c.faf8d2ee.js b/assets/js/5b5d3e9c.b738d9c0.js similarity index 95% rename from assets/js/5b5d3e9c.faf8d2ee.js rename to assets/js/5b5d3e9c.b738d9c0.js index e02379dc..ba4a8896 100644 --- a/assets/js/5b5d3e9c.faf8d2ee.js +++ b/assets/js/5b5d3e9c.b738d9c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5773],{3451:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>c,metadata:()=>o,toc:()=>u});var t=s(1085),i=s(1184);const c={},r="Function: isEqual()",o={id:"api/core/functions/isEqual",title:"Function: isEqual()",description:"isEqual(x, y): boolean",source:"@site/docs/api/core/functions/isEqual.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/isEqual",permalink:"/react-sigma/docs/api/core/functions/isEqual",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/isEqual.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: getUniqueKey()",permalink:"/react-sigma/docs/api/core/functions/getUniqueKey"},next:{title:"Function: useCamera()",permalink:"/react-sigma/docs/api/core/functions/useCamera"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-isequal",children:"Function: isEqual()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(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"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"x"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"y"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/utils.ts#L5",children:"packages/core/src/utils.ts:5"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(4041);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5773],{3451:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>c,metadata:()=>o,toc:()=>u});var t=s(1085),i=s(1184);const c={},r="Function: isEqual()",o={id:"api/core/functions/isEqual",title:"Function: isEqual()",description:"isEqual(x, y): boolean",source:"@site/docs/api/core/functions/isEqual.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/isEqual",permalink:"/react-sigma/docs/api/core/functions/isEqual",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/isEqual.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: getUniqueKey()",permalink:"/react-sigma/docs/api/core/functions/getUniqueKey"},next:{title:"Function: useCamera()",permalink:"/react-sigma/docs/api/core/functions/useCamera"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-isequal",children:"Function: isEqual()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(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"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"x"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"y"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/utils.ts#L5",children:"packages/core/src/utils.ts:5"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(4041);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6c60958d.edda47e7.js b/assets/js/6c60958d.3d5d69bd.js similarity index 98% rename from assets/js/6c60958d.edda47e7.js rename to assets/js/6c60958d.3d5d69bd.js index 5c46a82f..0b438442 100644 --- a/assets/js/6c60958d.edda47e7.js +++ b/assets/js/6c60958d.3d5d69bd.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5482],{2984:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>i});var a=o(1085),n=o(1184);const s={},r="Function: LayoutForceAtlas2Control()",c={id:"api/layout-forceatlas2/functions/LayoutForceAtlas2Control",title:"Function: LayoutForceAtlas2Control()",description:"LayoutForceAtlas2Control(props, context?): ReactNode",source:"@site/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control.md",sourceDirName:"api/layout-forceatlas2/functions",slug:"/api/layout-forceatlas2/functions/LayoutForceAtlas2Control",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"},next:{title:"Function: useLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2"}},l={},i=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"function-layoutforceatlas2control",children:"Function: LayoutForceAtlas2Control()"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.strong,{children:"LayoutForceAtlas2Control"}),"(",(0,a.jsx)(e.code,{children:"props"}),", ",(0,a.jsx)(e.code,{children:"context"}),"?): ",(0,a.jsx)(e.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,a.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(e.p,{children:["\u2022 ",(0,a.jsx)(e.strong,{children:"props"}),": ",(0,a.jsx)(e.a,{href:"/react-sigma/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",children:(0,a.jsx)(e.code,{children:"LayoutForceAtlas2ControlProps"})})]}),"\n",(0,a.jsxs)(e.p,{children:["\u2022 ",(0,a.jsx)(e.strong,{children:"context?"}),": ",(0,a.jsx)(e.code,{children:"any"})]}),"\n",(0,a.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.code,{children:"ReactNode"})}),"\n",(0,a.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L20",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20"})})]})}function d(t={}){const{wrapper:e}={...(0,n.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},1184:(t,e,o)=>{o.d(e,{R:()=>r,x:()=>c});var a=o(4041);const n={},s=a.createContext(n);function r(t){const e=a.useContext(s);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:r(t.components),a.createElement(s.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5482],{2984:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>i});var a=o(1085),n=o(1184);const s={},r="Function: LayoutForceAtlas2Control()",c={id:"api/layout-forceatlas2/functions/LayoutForceAtlas2Control",title:"Function: LayoutForceAtlas2Control()",description:"LayoutForceAtlas2Control(props, context?): ReactNode",source:"@site/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control.md",sourceDirName:"api/layout-forceatlas2/functions",slug:"/api/layout-forceatlas2/functions/LayoutForceAtlas2Control",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-forceatlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/"},next:{title:"Function: useLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2"}},l={},i=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"function-layoutforceatlas2control",children:"Function: LayoutForceAtlas2Control()"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.strong,{children:"LayoutForceAtlas2Control"}),"(",(0,a.jsx)(e.code,{children:"props"}),", ",(0,a.jsx)(e.code,{children:"context"}),"?): ",(0,a.jsx)(e.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,a.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(e.p,{children:["\u2022 ",(0,a.jsx)(e.strong,{children:"props"}),": ",(0,a.jsx)(e.a,{href:"/react-sigma/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",children:(0,a.jsx)(e.code,{children:"LayoutForceAtlas2ControlProps"})})]}),"\n",(0,a.jsxs)(e.p,{children:["\u2022 ",(0,a.jsx)(e.strong,{children:"context?"}),": ",(0,a.jsx)(e.code,{children:"any"})]}),"\n",(0,a.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.code,{children:"ReactNode"})}),"\n",(0,a.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L20",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:20"})})]})}function d(t={}){const{wrapper:e}={...(0,n.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},1184:(t,e,o)=>{o.d(e,{R:()=>r,x:()=>c});var a=o(4041);const n={},s=a.createContext(n);function r(t){const e=a.useContext(s);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:r(t.components),a.createElement(s.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f8401eb.fd149683.js b/assets/js/6f8401eb.202ad399.js similarity index 94% rename from assets/js/6f8401eb.fd149683.js rename to assets/js/6f8401eb.202ad399.js index a7e0785c..09268963 100644 --- a/assets/js/6f8401eb.fd149683.js +++ b/assets/js/6f8401eb.202ad399.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[819],{4597:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var i=t(1085),s=t(1184);const c={},o="Function: getUniqueKey()",r={id:"api/core/functions/getUniqueKey",title:"Function: getUniqueKey()",description:"getUniqueKey(): string",source:"@site/docs/api/core/functions/getUniqueKey.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/getUniqueKey",permalink:"/react-sigma/docs/api/core/functions/getUniqueKey",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/getUniqueKey.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: ZoomControl()",permalink:"/react-sigma/docs/api/core/functions/ZoomControl"},next:{title:"Function: isEqual()",permalink:"/react-sigma/docs/api/core/functions/isEqual"}},u={},a=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getuniquekey",children:"Function: getUniqueKey()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getUniqueKey"}),"(): ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/utils.ts#L1",children:"packages/core/src/utils.ts:1"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var i=t(4041);const s={},c=i.createContext(s);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[819],{4597:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var i=t(1085),s=t(1184);const c={},o="Function: getUniqueKey()",r={id:"api/core/functions/getUniqueKey",title:"Function: getUniqueKey()",description:"getUniqueKey(): string",source:"@site/docs/api/core/functions/getUniqueKey.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/getUniqueKey",permalink:"/react-sigma/docs/api/core/functions/getUniqueKey",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/getUniqueKey.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: ZoomControl()",permalink:"/react-sigma/docs/api/core/functions/ZoomControl"},next:{title:"Function: isEqual()",permalink:"/react-sigma/docs/api/core/functions/isEqual"}},u={},a=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getuniquekey",children:"Function: getUniqueKey()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getUniqueKey"}),"(): ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/utils.ts#L1",children:"packages/core/src/utils.ts:1"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var i=t(4041);const s={},c=i.createContext(s);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/700704ff.01fa10f7.js b/assets/js/700704ff.1f800a7c.js similarity index 91% rename from assets/js/700704ff.01fa10f7.js rename to assets/js/700704ff.1f800a7c.js index b83a1c7d..5ba7ae3b 100644 --- a/assets/js/700704ff.01fa10f7.js +++ b/assets/js/700704ff.1f800a7c.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1373],{5963:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>l,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>i,toc:()=>a});var t=n(1085),r=n(1184);const s={},c="Function: ZoomControl()",i={id:"api/core/functions/ZoomControl",title:"Function: ZoomControl()",description:"ZoomControl(props, context?): ReactNode",source:"@site/docs/api/core/functions/ZoomControl.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/ZoomControl",permalink:"/react-sigma/docs/api/core/functions/ZoomControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/ZoomControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: SigmaContainer()",permalink:"/react-sigma/docs/api/core/functions/SigmaContainer"},next:{title:"Function: getUniqueKey()",permalink:"/react-sigma/docs/api/core/functions/getUniqueKey"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.h1,{id:"function-zoomcontrol",children:"Function: ZoomControl()"}),"\n",(0,t.jsxs)(o.blockquote,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"ZoomControl"}),"(",(0,t.jsx)(o.code,{children:"props"}),", ",(0,t.jsx)(o.code,{children:"context"}),"?): ",(0,t.jsx)(o.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,t.jsxs)(o.p,{children:["The ",(0,t.jsx)(o.code,{children:"ZoomControl"})," create three UI buttons that allows the user to"]}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"zoom in"}),"\n",(0,t.jsx)(o.li,{children:"zoom out"}),"\n",(0,t.jsx)(o.li,{children:"reset zoom (ie. see the whole graph)"}),"\n"]}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(o.p,{children:"See [[ZoomControlProps]] for more information."}),"\n",(0,t.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(o.p,{children:["\u2022 ",(0,t.jsx)(o.strong,{children:"props"}),": ",(0,t.jsx)(o.a,{href:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",children:(0,t.jsx)(o.code,{children:"ZoomControlProps"})})]}),"\n",(0,t.jsxs)(o.p,{children:["\u2022 ",(0,t.jsx)(o.strong,{children:"context?"}),": ",(0,t.jsx)(o.code,{children:"any"})]}),"\n",(0,t.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(o.p,{children:(0,t.jsx)(o.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(o.p,{children:(0,t.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ZoomControl.tsx#L67",children:"packages/core/src/components/controls/ZoomControl.tsx:67"})})]})}function m(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},1184:(e,o,n)=>{n.d(o,{R:()=>c,x:()=>i});var t=n(4041);const r={},s=t.createContext(r);function c(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1373],{5963:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>a,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var t=n(1085),r=n(1184);const s={},c="Function: ZoomControl()",i={id:"api/core/functions/ZoomControl",title:"Function: ZoomControl()",description:"ZoomControl(props, context?): ReactNode",source:"@site/docs/api/core/functions/ZoomControl.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/ZoomControl",permalink:"/react-sigma/docs/api/core/functions/ZoomControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/ZoomControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: SigmaContainer()",permalink:"/react-sigma/docs/api/core/functions/SigmaContainer"},next:{title:"Function: getUniqueKey()",permalink:"/react-sigma/docs/api/core/functions/getUniqueKey"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.h1,{id:"function-zoomcontrol",children:"Function: ZoomControl()"}),"\n",(0,t.jsxs)(o.blockquote,{children:["\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.strong,{children:"ZoomControl"}),"(",(0,t.jsx)(o.code,{children:"props"}),", ",(0,t.jsx)(o.code,{children:"context"}),"?): ",(0,t.jsx)(o.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,t.jsxs)(o.p,{children:["The ",(0,t.jsx)(o.code,{children:"ZoomControl"})," create three UI buttons that allows the user to"]}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"zoom in"}),"\n",(0,t.jsx)(o.li,{children:"zoom out"}),"\n",(0,t.jsx)(o.li,{children:"reset zoom (ie. see the whole graph)"}),"\n"]}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,t.jsx)(o.p,{children:"See [[ZoomControlProps]] for more information."}),"\n",(0,t.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(o.p,{children:["\u2022 ",(0,t.jsx)(o.strong,{children:"props"}),": ",(0,t.jsx)(o.a,{href:"/react-sigma/docs/api/core/interfaces/ZoomControlProps",children:(0,t.jsx)(o.code,{children:"ZoomControlProps"})})]}),"\n",(0,t.jsxs)(o.p,{children:["\u2022 ",(0,t.jsx)(o.strong,{children:"context?"}),": ",(0,t.jsx)(o.code,{children:"any"})]}),"\n",(0,t.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(o.p,{children:(0,t.jsx)(o.code,{children:"ReactNode"})}),"\n",(0,t.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(o.p,{children:(0,t.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ZoomControl.tsx#L67",children:"packages/core/src/components/controls/ZoomControl.tsx:67"})})]})}function m(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},1184:(e,o,n)=>{n.d(o,{R:()=>c,x:()=>i});var t=n(4041);const r={},s=t.createContext(r);function c(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71d6bb1a.c03c2b83.js b/assets/js/71d6bb1a.bdfc5307.js similarity index 98% rename from assets/js/71d6bb1a.c03c2b83.js rename to assets/js/71d6bb1a.bdfc5307.js index ebade2f1..82a7fd77 100644 --- a/assets/js/71d6bb1a.c03c2b83.js +++ b/assets/js/71d6bb1a.bdfc5307.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[9619],{9986:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(1085),c=t(1184);const r={},i="Function: useSigmaContext()",o={id:"api/core/functions/useSigmaContext",title:"Function: useSigmaContext()",description:"useSigmaContext\\(): SigmaContextInterface\\",source:"@site/docs/api/core/functions/useSigmaContext.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useSigmaContext",permalink:"/react-sigma/docs/api/core/functions/useSigmaContext",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useSigmaContext.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useSigma()",permalink:"/react-sigma/docs/api/core/functions/useSigma"},next:{title:"Interface: ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-usesigmacontext",children:"Function: useSigmaContext()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useSigmaContext"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">(): ",(0,s.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,s.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"React hook that store the sigma and html container reference."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"const {sigma, container} = useSigmaContext();\n"})}),"\n",(0,s.jsx)(n.p,{children:"See [[SigmaContextInterface]] for more information."}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"N"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"E"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"G"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,s.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(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.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/context.ts#L34",children:"packages/core/src/hooks/context.ts:34"})})]})}function x(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>o});var s=t(4041);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(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([[9619],{9986:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(1085),c=t(1184);const r={},i="Function: useSigmaContext()",o={id:"api/core/functions/useSigmaContext",title:"Function: useSigmaContext()",description:"useSigmaContext\\(): SigmaContextInterface\\",source:"@site/docs/api/core/functions/useSigmaContext.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useSigmaContext",permalink:"/react-sigma/docs/api/core/functions/useSigmaContext",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useSigmaContext.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useSigma()",permalink:"/react-sigma/docs/api/core/functions/useSigma"},next:{title:"Interface: ControlsContainerProps",permalink:"/react-sigma/docs/api/core/interfaces/ControlsContainerProps"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-usesigmacontext",children:"Function: useSigmaContext()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useSigmaContext"}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">(): ",(0,s.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,s.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(0,s.jsx)(n.code,{children:"N"}),", ",(0,s.jsx)(n.code,{children:"E"}),", ",(0,s.jsx)(n.code,{children:"G"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"React hook that store the sigma and html container reference."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"const {sigma, container} = useSigmaContext();\n"})}),"\n",(0,s.jsx)(n.p,{children:"See [[SigmaContextInterface]] for more information."}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"N"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"E"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"G"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})," = ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface",children:(0,s.jsx)(n.code,{children:"SigmaContextInterface"})}),"<",(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.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/context.ts#L34",children:"packages/core/src/hooks/context.ts:34"})})]})}function x(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>o});var s=t(4041);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7267a26e.58b5170f.js b/assets/js/7267a26e.8d764956.js similarity index 96% rename from assets/js/7267a26e.58b5170f.js rename to assets/js/7267a26e.8d764956.js index a2bd7869..63589122 100644 --- a/assets/js/7267a26e.58b5170f.js +++ b/assets/js/7267a26e.8d764956.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1531],{6821:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var n=o(1085),r=o(1184);const s={},a="Function: useLayoutFactory()",c={id:"api/layout-core/functions/useLayoutFactory",title:"Function: useLayoutFactory()",description:"useLayoutFactory\\(layout, defaultSettings): LayoutHook\\",source:"@site/docs/api/layout-core/functions/useLayoutFactory.md",sourceDirName:"api/layout-core/functions",slug:"/api/layout-core/functions/useLayoutFactory",permalink:"/react-sigma/docs/api/layout-core/functions/useLayoutFactory",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/functions/useLayoutFactory.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: WorkerLayoutControl()",permalink:"/react-sigma/docs/api/layout-core/functions/WorkerLayoutControl"},next:{title:"Function: useWorkerLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useWorkerLayoutFactory"}},i={},u=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"function-uselayoutfactory",children:"Function: useLayoutFactory()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"useLayoutFactory"}),"<",(0,n.jsx)(t.code,{children:"T"}),">(",(0,n.jsx)(t.code,{children:"layout"}),", ",(0,n.jsx)(t.code,{children:"defaultSettings"}),"): ",(0,n.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook",children:(0,n.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Factory for layout hook."}),"\n",(0,n.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"T"})]}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"layout"}),": ",(0,n.jsx)(t.code,{children:"GraphologyLayout"}),"<",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"defaultSettings"}),": ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook",children:(0,n.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,n.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/useLayoutFactory.ts#L31",children:"useLayoutFactory.ts:31"})})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1184:(e,t,o)=>{o.d(t,{R:()=>a,x:()=>c});var n=o(4041);const r={},s=n.createContext(r);function a(e){const t=n.useContext(s);return n.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(r):e.components||r:a(e.components),n.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([[1531],{6821:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var n=o(1085),r=o(1184);const s={},a="Function: useLayoutFactory()",c={id:"api/layout-core/functions/useLayoutFactory",title:"Function: useLayoutFactory()",description:"useLayoutFactory\\(layout, defaultSettings): LayoutHook\\",source:"@site/docs/api/layout-core/functions/useLayoutFactory.md",sourceDirName:"api/layout-core/functions",slug:"/api/layout-core/functions/useLayoutFactory",permalink:"/react-sigma/docs/api/layout-core/functions/useLayoutFactory",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/functions/useLayoutFactory.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: WorkerLayoutControl()",permalink:"/react-sigma/docs/api/layout-core/functions/WorkerLayoutControl"},next:{title:"Function: useWorkerLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useWorkerLayoutFactory"}},i={},u=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"function-uselayoutfactory",children:"Function: useLayoutFactory()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"useLayoutFactory"}),"<",(0,n.jsx)(t.code,{children:"T"}),">(",(0,n.jsx)(t.code,{children:"layout"}),", ",(0,n.jsx)(t.code,{children:"defaultSettings"}),"): ",(0,n.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook",children:(0,n.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Factory for layout hook."}),"\n",(0,n.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"T"})]}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"layout"}),": ",(0,n.jsx)(t.code,{children:"GraphologyLayout"}),"<",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"defaultSettings"}),": ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook",children:(0,n.jsx)(t.code,{children:"LayoutHook"})}),"<",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,n.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/useLayoutFactory.ts#L31",children:"useLayoutFactory.ts:31"})})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1184:(e,t,o)=>{o.d(t,{R:()=>a,x:()=>c});var n=o(4041);const r={},s=n.createContext(r);function a(e){const t=n.useContext(s);return n.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(r):e.components||r:a(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/84db464d.4160ebf5.js b/assets/js/84db464d.3862c5b1.js similarity index 98% rename from assets/js/84db464d.4160ebf5.js rename to assets/js/84db464d.3862c5b1.js index f65f4318..1eeed25c 100644 --- a/assets/js/84db464d.4160ebf5.js +++ b/assets/js/84db464d.3862c5b1.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5279],{1714:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var o=r(1085),t=r(1184);const c={},s="Function: SearchControl()",i={id:"api/core/functions/SearchControl",title:"Function: SearchControl()",description:"SearchControl(props, context?): ReactNode",source:"@site/docs/api/core/functions/SearchControl.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/SearchControl",permalink:"/react-sigma/docs/api/core/functions/SearchControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/SearchControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: FullScreenControl()",permalink:"/react-sigma/docs/api/core/functions/FullScreenControl"},next:{title:"Function: SigmaContainer()",permalink:"/react-sigma/docs/api/core/functions/SigmaContainer"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-searchcontrol",children:"Function: SearchControl()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"SearchControl"}),"(",(0,o.jsx)(n.code,{children:"props"}),", ",(0,o.jsx)(n.code,{children:"context"}),"?): ",(0,o.jsx)(n.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.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,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,o.jsx)(n.p,{children:"See [[SearchControlProps]] for more information."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"props"}),": ",(0,o.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SearchControlProps",children:(0,o.jsx)(n.code,{children:"SearchControlProps"})})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"context?"}),": ",(0,o.jsx)(n.code,{children:"any"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/SearchControl.tsx#L53",children:"packages/core/src/components/controls/SearchControl.tsx:53"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>i});var o=r(4041);const t={},c=o.createContext(t);function s(e){const n=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5279],{1714:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var o=r(1085),t=r(1184);const c={},s="Function: SearchControl()",i={id:"api/core/functions/SearchControl",title:"Function: SearchControl()",description:"SearchControl(props, context?): ReactNode",source:"@site/docs/api/core/functions/SearchControl.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/SearchControl",permalink:"/react-sigma/docs/api/core/functions/SearchControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/SearchControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: FullScreenControl()",permalink:"/react-sigma/docs/api/core/functions/FullScreenControl"},next:{title:"Function: SigmaContainer()",permalink:"/react-sigma/docs/api/core/functions/SigmaContainer"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-searchcontrol",children:"Function: SearchControl()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"SearchControl"}),"(",(0,o.jsx)(n.code,{children:"props"}),", ",(0,o.jsx)(n.code,{children:"context"}),"?): ",(0,o.jsx)(n.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.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,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,o.jsx)(n.p,{children:"See [[SearchControlProps]] for more information."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"props"}),": ",(0,o.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/SearchControlProps",children:(0,o.jsx)(n.code,{children:"SearchControlProps"})})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"context?"}),": ",(0,o.jsx)(n.code,{children:"any"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/SearchControl.tsx#L53",children:"packages/core/src/components/controls/SearchControl.tsx:53"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>i});var o=r(4041);const t={},c=o.createContext(t);function s(e){const n=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e6581c0.c9fca975.js b/assets/js/8e6581c0.0a166768.js similarity index 98% rename from assets/js/8e6581c0.c9fca975.js rename to assets/js/8e6581c0.0a166768.js index 16ba88a1..e7b9c180 100644 --- a/assets/js/8e6581c0.c9fca975.js +++ b/assets/js/8e6581c0.0a166768.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5989],{7397:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>l,toc:()=>a});var o=r(1085),t=r(1184);const c={},s="Function: FullScreenControl()",l={id:"api/core/functions/FullScreenControl",title:"Function: FullScreenControl()",description:"FullScreenControl(props, context?): ReactNode",source:"@site/docs/api/core/functions/FullScreenControl.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/FullScreenControl",permalink:"/react-sigma/docs/api/core/functions/FullScreenControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/FullScreenControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: ControlsContainer()",permalink:"/react-sigma/docs/api/core/functions/ControlsContainer"},next:{title:"Function: SearchControl()",permalink:"/react-sigma/docs/api/core/functions/SearchControl"}},i={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-fullscreencontrol",children:"Function: FullScreenControl()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"FullScreenControl"}),"(",(0,o.jsx)(n.code,{children:"props"}),", ",(0,o.jsx)(n.code,{children:"context"}),"?): ",(0,o.jsx)(n.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"FullScreenControl"})," create a UI button that allows the user to display the graph in fullscreen"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,o.jsx)(n.p,{children:"See [[FullScreenControlProps]] for more information."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"props"}),": ",(0,o.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",children:(0,o.jsx)(n.code,{children:"FullScreenControlProps"})})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"context?"}),": ",(0,o.jsx)(n.code,{children:"any"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/FullScreenControl.tsx#L67",children:"packages/core/src/components/controls/FullScreenControl.tsx:67"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var o=r(4041);const t={},c=o.createContext(t);function s(e){const n=o.useContext(c);return o.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(t):e.components||t:s(e.components),o.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5989],{7397:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>l,toc:()=>a});var o=r(1085),t=r(1184);const c={},s="Function: FullScreenControl()",l={id:"api/core/functions/FullScreenControl",title:"Function: FullScreenControl()",description:"FullScreenControl(props, context?): ReactNode",source:"@site/docs/api/core/functions/FullScreenControl.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/FullScreenControl",permalink:"/react-sigma/docs/api/core/functions/FullScreenControl",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/FullScreenControl.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: ControlsContainer()",permalink:"/react-sigma/docs/api/core/functions/ControlsContainer"},next:{title:"Function: SearchControl()",permalink:"/react-sigma/docs/api/core/functions/SearchControl"}},i={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-fullscreencontrol",children:"Function: FullScreenControl()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"FullScreenControl"}),"(",(0,o.jsx)(n.code,{children:"props"}),", ",(0,o.jsx)(n.code,{children:"context"}),"?): ",(0,o.jsx)(n.code,{children:"ReactNode"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"FullScreenControl"})," create a UI button that allows the user to display the graph in fullscreen"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-jsx",children:"\n \n \n \n\n"})}),"\n",(0,o.jsx)(n.p,{children:"See [[FullScreenControlProps]] for more information."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"props"}),": ",(0,o.jsx)(n.a,{href:"/react-sigma/docs/api/core/interfaces/FullScreenControlProps",children:(0,o.jsx)(n.code,{children:"FullScreenControlProps"})})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"context?"}),": ",(0,o.jsx)(n.code,{children:"any"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"ReactNode"})}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/FullScreenControl.tsx#L67",children:"packages/core/src/components/controls/FullScreenControl.tsx:67"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var o=r(4041);const t={},c=o.createContext(t);function s(e){const n=o.useContext(c);return o.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(t):e.components||t:s(e.components),o.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/94632c8a.ea0936ce.js b/assets/js/94632c8a.d6256684.js similarity index 97% rename from assets/js/94632c8a.ea0936ce.js rename to assets/js/94632c8a.d6256684.js index 825359d0..9107c67a 100644 --- a/assets/js/94632c8a.ea0936ce.js +++ b/assets/js/94632c8a.d6256684.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[289],{7969:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(1085),n=t(1184);const o={},a="Function: useWorkerLayoutForceAtlas2()",c={id:"api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2",title:"Function: useWorkerLayoutForceAtlas2()",description:"useWorkerLayoutForceAtlas2(settings): object",source:"@site/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2.md",sourceDirName:"api/layout-forceatlas2/functions",slug:"/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2"},next:{title:"Type Alias: LayoutForceAtlas2ControlProps",permalink:"/react-sigma/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-useworkerlayoutforceatlas2",children:"Function: useWorkerLayoutForceAtlas2()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"useWorkerLayoutForceAtlas2"}),"(",(0,r.jsx)(s.code,{children:"settings"}),"): ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["React hook that helps you to manage worker of ",(0,r.jsx)(s.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForceAtlas2(...);\n"})}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"settings"}),": ",(0,r.jsx)(s.code,{children:"ForceAtlas2LayoutParameters"})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"object"})}),"\n",(0,r.jsx)(s.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isRunning"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"kill"}),": () => ",(0,r.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})}),"\n",(0,r.jsx)(s.h3,{id:"start",children:"start()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"start"}),": () => ",(0,r.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})}),"\n",(0,r.jsx)(s.h3,{id:"stop",children:"stop()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"stop"}),": () => ",(0,r.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})}),"\n",(0,r.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts#L14",children:"packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14"})})]})}function d(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>c});var r=t(4041);const n={},o=r.createContext(n);function a(e){const s=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[289],{7969:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(1085),n=t(1184);const o={},a="Function: useWorkerLayoutForceAtlas2()",c={id:"api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2",title:"Function: useWorkerLayoutForceAtlas2()",description:"useWorkerLayoutForceAtlas2(settings): object",source:"@site/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2.md",sourceDirName:"api/layout-forceatlas2/functions",slug:"/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2"},next:{title:"Type Alias: LayoutForceAtlas2ControlProps",permalink:"/react-sigma/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-useworkerlayoutforceatlas2",children:"Function: useWorkerLayoutForceAtlas2()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"useWorkerLayoutForceAtlas2"}),"(",(0,r.jsx)(s.code,{children:"settings"}),"): ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["React hook that helps you to manage worker of ",(0,r.jsx)(s.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForceAtlas2(...);\n"})}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"settings"}),": ",(0,r.jsx)(s.code,{children:"ForceAtlas2LayoutParameters"})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"object"})}),"\n",(0,r.jsx)(s.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isRunning"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"kill"}),": () => ",(0,r.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})}),"\n",(0,r.jsx)(s.h3,{id:"start",children:"start()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"start"}),": () => ",(0,r.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})}),"\n",(0,r.jsx)(s.h3,{id:"stop",children:"stop()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"stop"}),": () => ",(0,r.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})}),"\n",(0,r.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts#L14",children:"packages/layout-forceatlas2/src/useWorkerLayoutForceAtlas2.ts:14"})})]})}function d(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>c});var r=t(4041);const n={},o=r.createContext(n);function a(e){const s=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/999d5064.b46b1db7.js b/assets/js/999d5064.79b8cea9.js similarity index 87% rename from assets/js/999d5064.b46b1db7.js rename to assets/js/999d5064.79b8cea9.js index 9c620ecf..3ffdf11e 100644 --- a/assets/js/999d5064.b46b1db7.js +++ b/assets/js/999d5064.79b8cea9.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2799],{4146:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=i(1085),r=i(1184);const c={},t="Interface: SigmaContainerProps",o={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/SigmaContainerProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"},next:{title:"Interface: SigmaContextInterface\\",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"}},a={},d=[{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",blockquote:"blockquote",code:"code",em:"em",h1:"h1",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.jsx)(n.h1,{id:"interface-sigmacontainerpropsn-e-g",children:"Interface: SigmaContainerProps"}),"\n",(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.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"N"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"E"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"G"})," ",(0,s.jsx)(n.em,{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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"graph"}),": ",(0,s.jsx)(n.a,{href:"/react-sigma/docs/api/core/type-aliases/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"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(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"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/SigmaContainer.tsx#L45",children:"packages/core/src/components/SigmaContainer.tsx:45"})})]})}function h(e={}){const{wrapper:n}={...(0,r.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:()=>t,x:()=>o});var s=i(4041);const r={},c=s.createContext(r);function t(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2799],{4146:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=i(1085),r=i(1184);const c={},t="Interface: SigmaContainerProps",a={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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/SigmaContainerProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: SearchControlProps",permalink:"/react-sigma/docs/api/core/interfaces/SearchControlProps"},next:{title:"Interface: SigmaContextInterface\\",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContextInterface"}},o={},d=[{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",blockquote:"blockquote",code:"code",em:"em",h1:"h1",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.jsx)(n.h1,{id:"interface-sigmacontainerpropsn-e-g",children:"Interface: SigmaContainerProps"}),"\n",(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.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"N"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"E"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"G"})," ",(0,s.jsx)(n.em,{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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"graph"}),": ",(0,s.jsx)(n.a,{href:"/react-sigma/docs/api/core/type-aliases/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"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(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"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/SigmaContainer.tsx#L45",children:"packages/core/src/components/SigmaContainer.tsx:45"})})]})}function h(e={}){const{wrapper:n}={...(0,r.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:()=>t,x:()=>a});var s=i(4041);const r={},c=s.createContext(r);function t(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ff21ef4.22b8b346.js b/assets/js/9ff21ef4.33336284.js similarity index 98% rename from assets/js/9ff21ef4.22b8b346.js rename to assets/js/9ff21ef4.33336284.js index b737e9e5..dbc6f9e1 100644 --- a/assets/js/9ff21ef4.22b8b346.js +++ b/assets/js/9ff21ef4.33336284.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1462],{7215:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=s(1085),o=s(1184);const i={},t="Function: useCamera()",c={id:"api/core/functions/useCamera",title:"Function: useCamera()",description:"useCamera(options?): object",source:"@site/docs/api/core/functions/useCamera.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useCamera",permalink:"/react-sigma/docs/api/core/functions/useCamera",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useCamera.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: isEqual()",permalink:"/react-sigma/docs/api/core/functions/isEqual"},next:{title:"Function: useFullScreen()",permalink:"/react-sigma/docs/api/core/functions/useFullScreen"}},d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"goto()",id:"goto",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"gotoNode()",id:"gotonode",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"reset()",id:"reset",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"zoomIn()",id:"zoomin",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"zoomOut()",id:"zoomout",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in",level:2}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-usecamera",children:"Function: useCamera()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"useCamera"}),"(",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"React hook that helps you to manage the camera."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const {zoomIn, zoomOut, reset, goto, gotoNode } = useCamera();\n"})}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"CameraOptions"})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"object"})}),"\n",(0,r.jsx)(n.h3,{id:"goto",children:"goto()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"goto"}),": (",(0,r.jsx)(n.code,{children:"state"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"state"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"CameraState"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"AnimateOptions"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"gotonode",children:"gotoNode()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"gotoNode"}),": (",(0,r.jsx)(n.code,{children:"nodeKey"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"nodeKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"AnimateOptions"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"reset",children:"reset()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reset"}),": (",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"AnimateOptions"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"zoomin",children:"zoomIn()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"zoomIn"}),": (",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"CameraOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"zoomout",children:"zoomOut()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"zoomOut"}),": (",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"CameraOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/useCamera.ts#L19",children:"packages/core/src/hooks/useCamera.ts:19"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var r=s(4041);const o={},i=r.createContext(o);function t(e){const n=r.useContext(i);return r.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(o):e.components||o:t(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([[1462],{7215:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=s(1085),o=s(1184);const i={},t="Function: useCamera()",c={id:"api/core/functions/useCamera",title:"Function: useCamera()",description:"useCamera(options?): object",source:"@site/docs/api/core/functions/useCamera.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useCamera",permalink:"/react-sigma/docs/api/core/functions/useCamera",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useCamera.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: isEqual()",permalink:"/react-sigma/docs/api/core/functions/isEqual"},next:{title:"Function: useFullScreen()",permalink:"/react-sigma/docs/api/core/functions/useFullScreen"}},d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"goto()",id:"goto",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"gotoNode()",id:"gotonode",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"reset()",id:"reset",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"zoomIn()",id:"zoomin",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"zoomOut()",id:"zoomout",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in",level:2}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-usecamera",children:"Function: useCamera()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"useCamera"}),"(",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"React hook that helps you to manage the camera."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const {zoomIn, zoomOut, reset, goto, gotoNode } = useCamera();\n"})}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"CameraOptions"})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"object"})}),"\n",(0,r.jsx)(n.h3,{id:"goto",children:"goto()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"goto"}),": (",(0,r.jsx)(n.code,{children:"state"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"state"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"CameraState"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"AnimateOptions"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"gotonode",children:"gotoNode()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"gotoNode"}),": (",(0,r.jsx)(n.code,{children:"nodeKey"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"nodeKey"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"AnimateOptions"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"reset",children:"reset()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reset"}),": (",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"AnimateOptions"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"zoomin",children:"zoomIn()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"zoomIn"}),": (",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"CameraOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h3,{id:"zoomout",children:"zoomOut()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"zoomOut"}),": (",(0,r.jsx)(n.code,{children:"options"}),"?) => ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.code,{children:"CameraOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/useCamera.ts#L19",children:"packages/core/src/hooks/useCamera.ts:19"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var r=s(4041);const o={},i=r.createContext(o);function t(e){const n=r.useContext(i);return r.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(o):e.components||o:t(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a8addf22.ca4c0cc1.js b/assets/js/a8addf22.380ffa34.js similarity index 82% rename from assets/js/a8addf22.ca4c0cc1.js rename to assets/js/a8addf22.380ffa34.js index de647cf0..abf689ed 100644 --- a/assets/js/a8addf22.ca4c0cc1.js +++ b/assets/js/a8addf22.380ffa34.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6809],{9380:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=s(1085),o=s(1184);const i={},r="Function: useLayoutRandom()",a={id:"api/layout-random/functions/useLayoutRandom",title:"Function: useLayoutRandom()",description:"useLayoutRandom(settings?): object",source:"@site/docs/api/layout-random/functions/useLayoutRandom.md",sourceDirName:"api/layout-random/functions",slug:"/api/layout-random/functions/useLayoutRandom",permalink:"/react-sigma/docs/api/layout-random/functions/useLayoutRandom",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-random/functions/useLayoutRandom.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-random",permalink:"/react-sigma/docs/api/layout-random/"},next:{title:"Load a graph",permalink:"/react-sigma/docs/example/load-graph"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-uselayoutrandom",children:"Function: useLayoutRandom()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"useLayoutRandom"}),"(",(0,t.jsx)(n.code,{children:"settings"}),"?): ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"settings?"}),": ",(0,t.jsx)(n.code,{children:"RandomLayoutOptions"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h3,{id:"assign",children:"assign()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"assign"}),": () => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h3,{id:"positions",children:"positions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"positions"}),": () => ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-random/src/useLayoutRandom.ts#L14",children:"layout-random/src/useLayoutRandom.ts:14"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var t=s(4041);const o={},i=t.createContext(o);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.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([[6809],{9380:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var t=s(1085),o=s(1184);const i={},a="Function: useLayoutRandom()",r={id:"api/layout-random/functions/useLayoutRandom",title:"Function: useLayoutRandom()",description:"useLayoutRandom(settings?): object",source:"@site/docs/api/layout-random/functions/useLayoutRandom.md",sourceDirName:"api/layout-random/functions",slug:"/api/layout-random/functions/useLayoutRandom",permalink:"/react-sigma/docs/api/layout-random/functions/useLayoutRandom",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-random/functions/useLayoutRandom.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-random",permalink:"/react-sigma/docs/api/layout-random/"},next:{title:"Load a graph",permalink:"/react-sigma/docs/example/load-graph"}},d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-uselayoutrandom",children:"Function: useLayoutRandom()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"useLayoutRandom"}),"(",(0,t.jsx)(n.code,{children:"settings"}),"?): ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"settings?"}),": ",(0,t.jsx)(n.code,{children:"RandomLayoutOptions"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h3,{id:"assign",children:"assign()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"assign"}),": () => ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h3,{id:"positions",children:"positions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"positions"}),": () => ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"object"})}),"\n",(0,t.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-random/src/useLayoutRandom.ts#L14",children:"layout-random/src/useLayoutRandom.ts:14"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1184:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>r});var t=s(4041);const o={},i=t.createContext(o);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b025ee8f.9d5e5490.js b/assets/js/b025ee8f.8025b69c.js similarity index 87% rename from assets/js/b025ee8f.9d5e5490.js rename to assets/js/b025ee8f.8025b69c.js index e946d6f3..855885f4 100644 --- a/assets/js/b025ee8f.9d5e5490.js +++ b/assets/js/b025ee8f.8025b69c.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5378],{7048:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>i});var s=o(1085),a=o(1184);const r={},n="Type Alias: LayoutForceAtlas2ControlProps",c={id:"api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",title:"Type Alias: LayoutForceAtlas2ControlProps",description:'LayoutForceAtlas2ControlProps: Omit\\, "layout" \\| "settings"\\> & object',source:"@site/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps.md",sourceDirName:"api/layout-forceatlas2/type-aliases",slug:"/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",permalink:"/react-sigma/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2"},next:{title:"@react-sigma/layout-noverlap",permalink:"/react-sigma/docs/api/layout-noverlap/"}},l={},i=[{value:"Type declaration",id:"type-declaration",level:2},{value:"settings?",id:"settings",level:3},{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-layoutforceatlas2controlprops",children:"Type Alias: LayoutForceAtlas2ControlProps"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"LayoutForceAtlas2ControlProps"}),": ",(0,s.jsx)(t.code,{children:"Omit"}),"<",(0,s.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,s.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"}),">, ",(0,s.jsx)(t.code,{children:'"layout"'})," | ",(0,s.jsx)(t.code,{children:'"settings"'}),"> & ",(0,s.jsx)(t.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["Properties for ",(0,s.jsx)(t.code,{children:"LayoutForceAtlas2Control"})," component"]}),"\n",(0,s.jsx)(t.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsx)(t.h3,{id:"settings",children:"settings?"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"optional"})," ",(0,s.jsx)(t.strong,{children:"settings"}),": ",(0,s.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L10",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10"})})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1184:(e,t,o)=>{o.d(t,{R:()=>n,x:()=>c});var s=o(4041);const a={},r=s.createContext(a);function n(e){const t=s.useContext(r);return s.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(a):e.components||a:n(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([[5378],{7048:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>i});var s=o(1085),a=o(1184);const r={},n="Type Alias: LayoutForceAtlas2ControlProps",l={id:"api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",title:"Type Alias: LayoutForceAtlas2ControlProps",description:'LayoutForceAtlas2ControlProps: Omit\\, "layout" \\| "settings"\\> & object',source:"@site/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps.md",sourceDirName:"api/layout-forceatlas2/type-aliases",slug:"/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",permalink:"/react-sigma/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2"},next:{title:"@react-sigma/layout-noverlap",permalink:"/react-sigma/docs/api/layout-noverlap/"}},c={},i=[{value:"Type declaration",id:"type-declaration",level:2},{value:"settings?",id:"settings",level:3},{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-layoutforceatlas2controlprops",children:"Type Alias: LayoutForceAtlas2ControlProps"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"LayoutForceAtlas2ControlProps"}),": ",(0,s.jsx)(t.code,{children:"Omit"}),"<",(0,s.jsx)(t.code,{children:"WorkerLayoutControlProps"}),"<",(0,s.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"}),">, ",(0,s.jsx)(t.code,{children:'"layout"'})," | ",(0,s.jsx)(t.code,{children:'"settings"'}),"> & ",(0,s.jsx)(t.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["Properties for ",(0,s.jsx)(t.code,{children:"LayoutForceAtlas2Control"})," component"]}),"\n",(0,s.jsx)(t.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,s.jsx)(t.h3,{id:"settings",children:"settings?"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"optional"})," ",(0,s.jsx)(t.strong,{children:"settings"}),": ",(0,s.jsx)(t.code,{children:"ForceAtlas2LayoutParameters"})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx#L10",children:"packages/layout-forceatlas2/src/LayoutForceAtlas2Control.tsx:10"})})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1184:(e,t,o)=>{o.d(t,{R:()=>n,x:()=>l});var s=o(4041);const a={},r=s.createContext(a);function n(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5bbf372.1f4600ca.js b/assets/js/b5bbf372.a17f50b9.js similarity index 98% rename from assets/js/b5bbf372.1f4600ca.js rename to assets/js/b5bbf372.a17f50b9.js index bbf6e671..8f53059f 100644 --- a/assets/js/b5bbf372.1f4600ca.js +++ b/assets/js/b5bbf372.a17f50b9.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7186],{8352:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var n=t(1085),o=t(1184);const r={},a="Function: useLayoutForceAtlas2()",c={id:"api/layout-forceatlas2/functions/useLayoutForceAtlas2",title:"Function: useLayoutForceAtlas2()",description:"useLayoutForceAtlas2(settings?): object",source:"@site/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2.md",sourceDirName:"api/layout-forceatlas2/functions",slug:"/api/layout-forceatlas2/functions/useLayoutForceAtlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: LayoutForceAtlas2Control()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control"},next:{title:"Function: useWorkerLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"function-uselayoutforceatlas2",children:"Function: useLayoutForceAtlas2()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"useLayoutForceAtlas2"}),"(",(0,n.jsx)(s.code,{children:"settings"}),"?): ",(0,n.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["React hook that helps you to manage ",(0,n.jsx)(s.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForceAtlas2(...);\n"})}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"settings?"}),": ",(0,n.jsx)(s.code,{children:"ForceAtlas2SynchronousLayoutParameters"}),"<",(0,n.jsx)(s.code,{children:"Attributes"}),", ",(0,n.jsx)(s.code,{children:"Attributes"}),">"]}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"object"})}),"\n",(0,n.jsx)(s.h3,{id:"assign",children:"assign()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"assign"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h3,{id:"positions",children:"positions()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"positions"}),": () => ",(0,n.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"object"})}),"\n",(0,n.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts#L13",children:"packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13"})})]})}function d(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>c});var n=t(4041);const o={},r=n.createContext(o);function a(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7186],{8352:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var n=t(1085),o=t(1184);const r={},a="Function: useLayoutForceAtlas2()",c={id:"api/layout-forceatlas2/functions/useLayoutForceAtlas2",title:"Function: useLayoutForceAtlas2()",description:"useLayoutForceAtlas2(settings?): object",source:"@site/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2.md",sourceDirName:"api/layout-forceatlas2/functions",slug:"/api/layout-forceatlas2/functions/useLayoutForceAtlas2",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: LayoutForceAtlas2Control()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control"},next:{title:"Function: useWorkerLayoutForceAtlas2()",permalink:"/react-sigma/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2"}},i={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"function-uselayoutforceatlas2",children:"Function: useLayoutForceAtlas2()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"useLayoutForceAtlas2"}),"(",(0,n.jsx)(s.code,{children:"settings"}),"?): ",(0,n.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsxs)(s.p,{children:["React hook that helps you to manage ",(0,n.jsx)(s.a,{href:"https://graphology.github.io/standard-library/layout-forceatlas2.html",children:"force atlas2 layout"}),"."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutForceAtlas2(...);\n"})}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"settings?"}),": ",(0,n.jsx)(s.code,{children:"ForceAtlas2SynchronousLayoutParameters"}),"<",(0,n.jsx)(s.code,{children:"Attributes"}),", ",(0,n.jsx)(s.code,{children:"Attributes"}),">"]}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"object"})}),"\n",(0,n.jsx)(s.h3,{id:"assign",children:"assign()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"assign"}),": () => ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h3,{id:"positions",children:"positions()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"positions"}),": () => ",(0,n.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"object"})}),"\n",(0,n.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts#L13",children:"packages/layout-forceatlas2/src/useLayoutForceAtlas2.ts:13"})})]})}function d(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>c});var n=t(4041);const o={},r=n.createContext(o);function a(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b94983b7.ba87ef7b.js b/assets/js/b94983b7.75fe6c6e.js similarity index 97% rename from assets/js/b94983b7.ba87ef7b.js rename to assets/js/b94983b7.75fe6c6e.js index 1ee6cb2e..325648f7 100644 --- a/assets/js/b94983b7.ba87ef7b.js +++ b/assets/js/b94983b7.75fe6c6e.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[8795],{7489:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=r(1085),c=r(1184);const i={},s="Function: SigmaContainer()",o={id:"api/core/functions/SigmaContainer",title:"Function: SigmaContainer()",description:"SigmaContainer\\(props): ReactElement\\\\>",source:"@site/docs/api/core/functions/SigmaContainer.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/SigmaContainer",permalink:"/react-sigma/docs/api/core/functions/SigmaContainer",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/SigmaContainer.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: SearchControl()",permalink:"/react-sigma/docs/api/core/functions/SearchControl"},next:{title:"Function: ZoomControl()",permalink:"/react-sigma/docs/api/core/functions/ZoomControl"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-sigmacontainer",children:"Function: SigmaContainer()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(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"]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"N"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"E"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"G"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"props"}),": ",(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:"object"})," & ",(0,t.jsx)(n.code,{children:"RefAttributes"}),"<",(0,t.jsx)(n.code,{children:"null"})," | ",(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.h2,{id:"returns",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.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/SigmaContainer.tsx#L141",children:"packages/core/src/components/SigmaContainer.tsx:141"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>o});var t=r(4041);const c={},i=t.createContext(c);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),t.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([[8795],{7489:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=r(1085),c=r(1184);const i={},s="Function: SigmaContainer()",o={id:"api/core/functions/SigmaContainer",title:"Function: SigmaContainer()",description:"SigmaContainer\\(props): ReactElement\\\\>",source:"@site/docs/api/core/functions/SigmaContainer.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/SigmaContainer",permalink:"/react-sigma/docs/api/core/functions/SigmaContainer",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/SigmaContainer.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: SearchControl()",permalink:"/react-sigma/docs/api/core/functions/SearchControl"},next:{title:"Function: ZoomControl()",permalink:"/react-sigma/docs/api/core/functions/ZoomControl"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-sigmacontainer",children:"Function: SigmaContainer()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(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"]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"N"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"E"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"G"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Attributes"})," = ",(0,t.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"props"}),": ",(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:"object"})," & ",(0,t.jsx)(n.code,{children:"RefAttributes"}),"<",(0,t.jsx)(n.code,{children:"null"})," | ",(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.h2,{id:"returns",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.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/SigmaContainer.tsx#L141",children:"packages/core/src/components/SigmaContainer.tsx:141"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>o});var t=r(4041);const c={},i=t.createContext(c);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c6c56b9b.d732032f.js b/assets/js/c6c56b9b.6c5cddb7.js similarity index 97% rename from assets/js/c6c56b9b.d732032f.js rename to assets/js/c6c56b9b.6c5cddb7.js index 7125bb28..0195d464 100644 --- a/assets/js/c6c56b9b.d732032f.js +++ b/assets/js/c6c56b9b.6c5cddb7.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6217],{8882:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var s=r(1085),o=r(1184);const t={},i="Function: useWorkerLayoutNoverlap()",l={id:"api/layout-noverlap/functions/useWorkerLayoutNoverlap",title:"Function: useWorkerLayoutNoverlap()",description:"useWorkerLayoutNoverlap(settings): object",source:"@site/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap.md",sourceDirName:"api/layout-noverlap/functions",slug:"/api/layout-noverlap/functions/useWorkerLayoutNoverlap",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useLayoutNoverlap"},next:{title:"Type Alias: LayoutNoverlapControlProps",permalink:"/react-sigma/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps"}},a={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-useworkerlayoutnoverlap",children:"Function: useWorkerLayoutNoverlap()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useWorkerLayoutNoverlap"}),"(",(0,s.jsx)(n.code,{children:"settings"}),"): ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["React hook that helps you to manage worker for ",(0,s.jsx)(n.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutNoverlap({layoutOptions});\n"})}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"settings"}),": ",(0,s.jsx)(n.code,{children:"NoverlapLayoutSupervisorParameters"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"object"})}),"\n",(0,s.jsx)(n.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isRunning"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"kill",children:"kill()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"kill"}),": () => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"start()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"start"}),": () => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stop"}),": () => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var s=r(4041);const o={},t=s.createContext(o);function i(e){const n=s.useContext(t);return s.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(o):e.components||o:i(e.components),s.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([[6217],{8882:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var s=r(1085),o=r(1184);const t={},i="Function: useWorkerLayoutNoverlap()",l={id:"api/layout-noverlap/functions/useWorkerLayoutNoverlap",title:"Function: useWorkerLayoutNoverlap()",description:"useWorkerLayoutNoverlap(settings): object",source:"@site/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap.md",sourceDirName:"api/layout-noverlap/functions",slug:"/api/layout-noverlap/functions/useWorkerLayoutNoverlap",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useLayoutNoverlap"},next:{title:"Type Alias: LayoutNoverlapControlProps",permalink:"/react-sigma/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps"}},a={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-useworkerlayoutnoverlap",children:"Function: useWorkerLayoutNoverlap()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useWorkerLayoutNoverlap"}),"(",(0,s.jsx)(n.code,{children:"settings"}),"): ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["React hook that helps you to manage worker for ",(0,s.jsx)(n.a,{href:"https://graphology.github.io/standard-library/layout-noverlap.html",children:"noverlap layout"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutNoverlap({layoutOptions});\n"})}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"settings"}),": ",(0,s.jsx)(n.code,{children:"NoverlapLayoutSupervisorParameters"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"object"})}),"\n",(0,s.jsx)(n.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isRunning"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"kill",children:"kill()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"kill"}),": () => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"start()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"start"}),": () => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stop"}),": () => ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts#L13",children:"packages/layout-noverlap/src/useWorkerLayoutNoverlap.ts:13"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var s=r(4041);const o={},t=s.createContext(o);function i(e){const n=s.useContext(t);return s.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(o):e.components||o:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7bdaeff.6acad953.js b/assets/js/c7bdaeff.b41f18dd.js similarity index 90% rename from assets/js/c7bdaeff.6acad953.js rename to assets/js/c7bdaeff.b41f18dd.js index cb9994f3..2438111f 100644 --- a/assets/js/c7bdaeff.6acad953.js +++ b/assets/js/c7bdaeff.b41f18dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[9405],{1047:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>n,metadata:()=>a,toc:()=>d});var r=t(1085),c=t(1184);const n={},i="Type Alias: GraphType",a={id:"api/core/type-aliases/GraphType",title:"Type Alias: GraphType\\",description:"GraphType\\: AbstractGraph\\ \\| GraphConstructor\\",source:"@site/docs/api/core/type-aliases/GraphType.md",sourceDirName:"api/core/type-aliases",slug:"/api/core/type-aliases/GraphType",permalink:"/react-sigma/docs/api/core/type-aliases/GraphType",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/type-aliases/GraphType.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Type Alias: EventHandlers",permalink:"/react-sigma/docs/api/core/type-aliases/EventHandlers"},next:{title:"@react-sigma/layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"}},o={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"type-alias-graphtypen-e-g",children:"Type Alias: GraphType"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"GraphType"}),"<",(0,r.jsx)(s.code,{children:"N"}),", ",(0,r.jsx)(s.code,{children:"E"}),", ",(0,r.jsx)(s.code,{children:"G"}),">: ",(0,r.jsx)(s.code,{children:"AbstractGraph"}),"<",(0,r.jsx)(s.code,{children:"N"}),", ",(0,r.jsx)(s.code,{children:"E"}),", ",(0,r.jsx)(s.code,{children:"G"}),"> | ",(0,r.jsx)(s.code,{children:"GraphConstructor"}),"<",(0,r.jsx)(s.code,{children:"N"}),", ",(0,r.jsx)(s.code,{children:"E"}),", ",(0,r.jsx)(s.code,{children:"G"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"N"})," ",(0,r.jsx)(s.em,{children:"extends"})," ",(0,r.jsx)(s.code,{children:"Attributes"})," = ",(0,r.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"E"})," ",(0,r.jsx)(s.em,{children:"extends"})," ",(0,r.jsx)(s.code,{children:"Attributes"})," = ",(0,r.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"G"})," ",(0,r.jsx)(s.em,{children:"extends"})," ",(0,r.jsx)(s.code,{children:"Attributes"})," = ",(0,r.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,r.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/types.ts#L17",children:"packages/core/src/types.ts:17"})})]})}function l(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>i,x:()=>a});var r=t(4041);const c={},n=r.createContext(c);function i(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[9405],{1047:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>n,metadata:()=>a,toc:()=>o});var r=t(1085),c=t(1184);const n={},i="Type Alias: GraphType",a={id:"api/core/type-aliases/GraphType",title:"Type Alias: GraphType\\",description:"GraphType\\: AbstractGraph\\ \\| GraphConstructor\\",source:"@site/docs/api/core/type-aliases/GraphType.md",sourceDirName:"api/core/type-aliases",slug:"/api/core/type-aliases/GraphType",permalink:"/react-sigma/docs/api/core/type-aliases/GraphType",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/type-aliases/GraphType.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Type Alias: EventHandlers",permalink:"/react-sigma/docs/api/core/type-aliases/EventHandlers"},next:{title:"@react-sigma/layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"}},d={},o=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"type-alias-graphtypen-e-g",children:"Type Alias: GraphType"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"GraphType"}),"<",(0,r.jsx)(s.code,{children:"N"}),", ",(0,r.jsx)(s.code,{children:"E"}),", ",(0,r.jsx)(s.code,{children:"G"}),">: ",(0,r.jsx)(s.code,{children:"AbstractGraph"}),"<",(0,r.jsx)(s.code,{children:"N"}),", ",(0,r.jsx)(s.code,{children:"E"}),", ",(0,r.jsx)(s.code,{children:"G"}),"> | ",(0,r.jsx)(s.code,{children:"GraphConstructor"}),"<",(0,r.jsx)(s.code,{children:"N"}),", ",(0,r.jsx)(s.code,{children:"E"}),", ",(0,r.jsx)(s.code,{children:"G"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"N"})," ",(0,r.jsx)(s.em,{children:"extends"})," ",(0,r.jsx)(s.code,{children:"Attributes"})," = ",(0,r.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"E"})," ",(0,r.jsx)(s.em,{children:"extends"})," ",(0,r.jsx)(s.code,{children:"Attributes"})," = ",(0,r.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"G"})," ",(0,r.jsx)(s.em,{children:"extends"})," ",(0,r.jsx)(s.code,{children:"Attributes"})," = ",(0,r.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,r.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/types.ts#L17",children:"packages/core/src/types.ts:17"})})]})}function l(e={}){const{wrapper:s}={...(0,c.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>i,x:()=>a});var r=t(4041);const c={},n=r.createContext(c);function i(e){const s=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(n.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc19ab3b.8dd06ffe.js b/assets/js/cc19ab3b.1520a63e.js similarity index 91% rename from assets/js/cc19ab3b.8dd06ffe.js rename to assets/js/cc19ab3b.1520a63e.js index a085a303..d7005302 100644 --- a/assets/js/cc19ab3b.8dd06ffe.js +++ b/assets/js/cc19ab3b.1520a63e.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6937],{2991:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(1085),n=o(1184);const s={},a="Function: useWorkerLayoutFactory()",c={id:"api/layout-core/functions/useWorkerLayoutFactory",title:"Function: useWorkerLayoutFactory()",description:"useWorkerLayoutFactory\\(worker): LayoutWorkerHook\\",source:"@site/docs/api/layout-core/functions/useWorkerLayoutFactory.md",sourceDirName:"api/layout-core/functions",slug:"/api/layout-core/functions/useWorkerLayoutFactory",permalink:"/react-sigma/docs/api/layout-core/functions/useWorkerLayoutFactory",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/functions/useWorkerLayoutFactory.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useLayoutFactory"},next:{title:"Interface: WorkerLayoutControlProps\\",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"}},i={},u=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-useworkerlayoutfactory",children:"Function: useWorkerLayoutFactory()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"useWorkerLayoutFactory"}),"<",(0,t.jsx)(r.code,{children:"T"}),">(",(0,t.jsx)(r.code,{children:"worker"}),"): ",(0,t.jsx)(r.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",children:(0,t.jsx)(r.code,{children:"LayoutWorkerHook"})}),"<",(0,t.jsx)(r.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"worker"}),": ",(0,t.jsx)(r.code,{children:"GraphologyWorkerLayoutConstructor"}),"<",(0,t.jsx)(r.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",children:(0,t.jsx)(r.code,{children:"LayoutWorkerHook"})}),"<",(0,t.jsx)(r.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/useWorkerLayoutFactory.ts#L23",children:"useWorkerLayoutFactory.ts:23"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,r,o)=>{o.d(r,{R:()=>a,x:()=>c});var t=o(4041);const n={},s=t.createContext(n);function a(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6937],{2991:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>i,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(1085),n=o(1184);const s={},a="Function: useWorkerLayoutFactory()",c={id:"api/layout-core/functions/useWorkerLayoutFactory",title:"Function: useWorkerLayoutFactory()",description:"useWorkerLayoutFactory\\(worker): LayoutWorkerHook\\",source:"@site/docs/api/layout-core/functions/useWorkerLayoutFactory.md",sourceDirName:"api/layout-core/functions",slug:"/api/layout-core/functions/useWorkerLayoutFactory",permalink:"/react-sigma/docs/api/layout-core/functions/useWorkerLayoutFactory",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/functions/useWorkerLayoutFactory.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useLayoutFactory"},next:{title:"Interface: WorkerLayoutControlProps\\",permalink:"/react-sigma/docs/api/layout-core/interfaces/WorkerLayoutControlProps"}},i={},u=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-useworkerlayoutfactory",children:"Function: useWorkerLayoutFactory()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"useWorkerLayoutFactory"}),"<",(0,t.jsx)(r.code,{children:"T"}),">(",(0,t.jsx)(r.code,{children:"worker"}),"): ",(0,t.jsx)(r.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",children:(0,t.jsx)(r.code,{children:"LayoutWorkerHook"})}),"<",(0,t.jsx)(r.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"worker"}),": ",(0,t.jsx)(r.code,{children:"GraphologyWorkerLayoutConstructor"}),"<",(0,t.jsx)(r.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",children:(0,t.jsx)(r.code,{children:"LayoutWorkerHook"})}),"<",(0,t.jsx)(r.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/useWorkerLayoutFactory.ts#L23",children:"useWorkerLayoutFactory.ts:23"})})]})}function l(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},1184:(e,r,o)=>{o.d(r,{R:()=>a,x:()=>c});var t=o(4041);const n={},s=t.createContext(n);function a(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d0955971.d85be16f.js b/assets/js/d0955971.72135119.js similarity index 96% rename from assets/js/d0955971.d85be16f.js rename to assets/js/d0955971.72135119.js index 70a2fc60..4da325da 100644 --- a/assets/js/d0955971.d85be16f.js +++ b/assets/js/d0955971.72135119.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7759],{8890:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>c});var r=t(1085),a=t(1184);const n={},s="Type Alias: LayoutNoverlapControlProps",l={id:"api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",title:"Type Alias: LayoutNoverlapControlProps",description:'LayoutNoverlapControlProps: Omit\\, "layout" \\| "settings"\\> & object',source:"@site/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps.md",sourceDirName:"api/layout-noverlap/type-aliases",slug:"/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",permalink:"/react-sigma/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap"},next:{title:"@react-sigma/layout-random",permalink:"/react-sigma/docs/api/layout-random/"}},i={},c=[{value:"Type declaration",id:"type-declaration",level:2},{value:"settings?",id:"settings",level:3},{value:"Defined in",id:"defined-in",level:2}];function p(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(o.h1,{id:"type-alias-layoutnoverlapcontrolprops",children:"Type Alias: LayoutNoverlapControlProps"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.strong,{children:"LayoutNoverlapControlProps"}),": ",(0,r.jsx)(o.code,{children:"Omit"}),"<",(0,r.jsx)(o.code,{children:"WorkerLayoutControlProps"}),"<",(0,r.jsx)(o.code,{children:"NoverlapLayoutSupervisorParameters"}),">, ",(0,r.jsx)(o.code,{children:'"layout"'})," | ",(0,r.jsx)(o.code,{children:'"settings"'}),"> & ",(0,r.jsx)(o.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(o.p,{children:["Properties for ",(0,r.jsx)(o.code,{children:"NoverlapControl"})," component"]}),"\n",(0,r.jsx)(o.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(o.h3,{id:"settings",children:"settings?"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.code,{children:"optional"})," ",(0,r.jsx)(o.strong,{children:"settings"}),": ",(0,r.jsx)(o.code,{children:"NoverlapLayoutSupervisorParameters"})]}),"\n"]}),"\n",(0,r.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(o.p,{children:(0,r.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L10",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:10"})})]})}function d(e={}){const{wrapper:o}={...(0,a.R)(),...e.components};return o?(0,r.jsx)(o,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>l});var r=t(4041);const a={},n=r.createContext(a);function s(e){const o=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function l(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),r.createElement(n.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7759],{8890:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>c});var r=t(1085),a=t(1184);const n={},s="Type Alias: LayoutNoverlapControlProps",l={id:"api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",title:"Type Alias: LayoutNoverlapControlProps",description:'LayoutNoverlapControlProps: Omit\\, "layout" \\| "settings"\\> & object',source:"@site/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps.md",sourceDirName:"api/layout-noverlap/type-aliases",slug:"/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",permalink:"/react-sigma/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutNoverlap()",permalink:"/react-sigma/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap"},next:{title:"@react-sigma/layout-random",permalink:"/react-sigma/docs/api/layout-random/"}},i={},c=[{value:"Type declaration",id:"type-declaration",level:2},{value:"settings?",id:"settings",level:3},{value:"Defined in",id:"defined-in",level:2}];function p(e){const o={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(o.h1,{id:"type-alias-layoutnoverlapcontrolprops",children:"Type Alias: LayoutNoverlapControlProps"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.strong,{children:"LayoutNoverlapControlProps"}),": ",(0,r.jsx)(o.code,{children:"Omit"}),"<",(0,r.jsx)(o.code,{children:"WorkerLayoutControlProps"}),"<",(0,r.jsx)(o.code,{children:"NoverlapLayoutSupervisorParameters"}),">, ",(0,r.jsx)(o.code,{children:'"layout"'})," | ",(0,r.jsx)(o.code,{children:'"settings"'}),"> & ",(0,r.jsx)(o.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(o.p,{children:["Properties for ",(0,r.jsx)(o.code,{children:"NoverlapControl"})," component"]}),"\n",(0,r.jsx)(o.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(o.h3,{id:"settings",children:"settings?"}),"\n",(0,r.jsxs)(o.blockquote,{children:["\n",(0,r.jsxs)(o.p,{children:[(0,r.jsx)(o.code,{children:"optional"})," ",(0,r.jsx)(o.strong,{children:"settings"}),": ",(0,r.jsx)(o.code,{children:"NoverlapLayoutSupervisorParameters"})]}),"\n"]}),"\n",(0,r.jsx)(o.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(o.p,{children:(0,r.jsx)(o.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-noverlap/src/LayoutNoverlapControl.tsx#L10",children:"packages/layout-noverlap/src/LayoutNoverlapControl.tsx:10"})})]})}function d(e={}){const{wrapper:o}={...(0,a.R)(),...e.components};return o?(0,r.jsx)(o,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1184:(e,o,t)=>{t.d(o,{R:()=>s,x:()=>l});var r=t(4041);const a={},n=r.createContext(a);function s(e){const o=r.useContext(n);return r.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function l(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),r.createElement(n.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/de170a46.7679a508.js b/assets/js/de170a46.09850044.js similarity index 93% rename from assets/js/de170a46.7679a508.js rename to assets/js/de170a46.09850044.js index 22799f18..cdf05061 100644 --- a/assets/js/de170a46.7679a508.js +++ b/assets/js/de170a46.09850044.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[9653],{4983:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var r=t(1085),i=t(1184);const s={},c="Interface: SigmaContextInterface",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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/SigmaContextInterface.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: SigmaContainerProps\\",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps"},next:{title:"Interface: 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 n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-sigmacontextinterfacen-e-g",children:"Interface: SigmaContextInterface"}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"N"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"Attributes"})," = ",(0,r.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"E"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"Attributes"})," = ",(0,r.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"G"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"Attributes"})," = ",(0,r.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"container",children:"container"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"container"}),": ",(0,r.jsx)(n.code,{children:"HTMLElement"})]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/context.ts#L11",children:"packages/core/src/hooks/context.ts:11"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sigma",children:"sigma"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"sigma"}),": ",(0,r.jsx)(n.code,{children:"Sigma"}),"<",(0,r.jsx)(n.code,{children:"N"}),", ",(0,r.jsx)(n.code,{children:"E"}),", ",(0,r.jsx)(n.code,{children:"G"}),">"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/context.ts#L10",children:"packages/core/src/hooks/context.ts:10"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(4041);const i={},s=r.createContext(i);function c(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[9653],{4983:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var r=t(1085),i=t(1184);const s={},c="Interface: SigmaContextInterface",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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/SigmaContextInterface.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: SigmaContainerProps\\",permalink:"/react-sigma/docs/api/core/interfaces/SigmaContainerProps"},next:{title:"Interface: 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 n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-sigmacontextinterfacen-e-g",children:"Interface: SigmaContextInterface"}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"N"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"Attributes"})," = ",(0,r.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"E"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"Attributes"})," = ",(0,r.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"G"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"Attributes"})," = ",(0,r.jsx)(n.code,{children:"Attributes"})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"container",children:"container"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"container"}),": ",(0,r.jsx)(n.code,{children:"HTMLElement"})]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/context.ts#L11",children:"packages/core/src/hooks/context.ts:11"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sigma",children:"sigma"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"sigma"}),": ",(0,r.jsx)(n.code,{children:"Sigma"}),"<",(0,r.jsx)(n.code,{children:"N"}),", ",(0,r.jsx)(n.code,{children:"E"}),", ",(0,r.jsx)(n.code,{children:"G"}),">"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/context.ts#L10",children:"packages/core/src/hooks/context.ts:10"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},1184:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(4041);const i={},s=r.createContext(i);function c(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e60724d1.4d555e1c.js b/assets/js/e60724d1.a83bcb85.js similarity index 96% rename from assets/js/e60724d1.4d555e1c.js rename to assets/js/e60724d1.a83bcb85.js index 73a2ee7b..c4841bea 100644 --- a/assets/js/e60724d1.4d555e1c.js +++ b/assets/js/e60724d1.a83bcb85.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5362],{5624:(e,c,s)=>{s.r(c),s.d(c,{assets:()=>o,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var n=s(1085),t=s(1184);const i={},r="Function: useLayoutCirclepack()",a={id:"api/layout-circlepack/functions/useLayoutCirclepack",title:"Function: useLayoutCirclepack()",description:"useLayoutCirclepack(settings?): object",source:"@site/docs/api/layout-circlepack/functions/useLayoutCirclepack.md",sourceDirName:"api/layout-circlepack/functions",slug:"/api/layout-circlepack/functions/useLayoutCirclepack",permalink:"/react-sigma/docs/api/layout-circlepack/functions/useLayoutCirclepack",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-circlepack/functions/useLayoutCirclepack.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"},next:{title:"@react-sigma/layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const c={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(c.h1,{id:"function-uselayoutcirclepack",children:"Function: useLayoutCirclepack()"}),"\n",(0,n.jsxs)(c.blockquote,{children:["\n",(0,n.jsxs)(c.p,{children:[(0,n.jsx)(c.strong,{children:"useLayoutCirclepack"}),"(",(0,n.jsx)(c.code,{children:"settings"}),"?): ",(0,n.jsx)(c.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsxs)(c.p,{children:["React hook that helps you to manage ",(0,n.jsx)(c.a,{href:"https://graphology.github.io/standard-library/layout.html#circlepack",children:"circlepack layout"}),"."]}),"\n",(0,n.jsx)(c.pre,{children:(0,n.jsx)(c.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCirclepack({...});\n"})}),"\n",(0,n.jsx)(c.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(c.p,{children:["\u2022 ",(0,n.jsx)(c.strong,{children:"settings?"}),": ",(0,n.jsx)(c.code,{children:"CirclePackLayoutOptions"})]}),"\n",(0,n.jsx)(c.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.code,{children:"object"})}),"\n",(0,n.jsx)(c.h3,{id:"assign",children:"assign()"}),"\n",(0,n.jsxs)(c.blockquote,{children:["\n",(0,n.jsxs)(c.p,{children:[(0,n.jsx)(c.strong,{children:"assign"}),": () => ",(0,n.jsx)(c.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(c.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.code,{children:"void"})}),"\n",(0,n.jsx)(c.h3,{id:"positions",children:"positions()"}),"\n",(0,n.jsxs)(c.blockquote,{children:["\n",(0,n.jsxs)(c.p,{children:[(0,n.jsx)(c.strong,{children:"positions"}),": () => ",(0,n.jsx)(c.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(c.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.code,{children:"object"})}),"\n",(0,n.jsx)(c.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-circlepack/src/useLayoutCirclepack.ts#L13",children:"layout-circlepack/src/useLayoutCirclepack.ts:13"})})]})}function d(e={}){const{wrapper:c}={...(0,t.R)(),...e.components};return c?(0,n.jsx)(c,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,c,s)=>{s.d(c,{R:()=>r,x:()=>a});var n=s(4041);const t={},i=n.createContext(t);function r(e){const c=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(c):{...c,...e}}),[c,e])}function a(e){let c;return c=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(i.Provider,{value:c},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[5362],{5624:(e,c,s)=>{s.r(c),s.d(c,{assets:()=>o,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var n=s(1085),t=s(1184);const i={},r="Function: useLayoutCirclepack()",a={id:"api/layout-circlepack/functions/useLayoutCirclepack",title:"Function: useLayoutCirclepack()",description:"useLayoutCirclepack(settings?): object",source:"@site/docs/api/layout-circlepack/functions/useLayoutCirclepack.md",sourceDirName:"api/layout-circlepack/functions",slug:"/api/layout-circlepack/functions/useLayoutCirclepack",permalink:"/react-sigma/docs/api/layout-circlepack/functions/useLayoutCirclepack",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-circlepack/functions/useLayoutCirclepack.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-circlepack",permalink:"/react-sigma/docs/api/layout-circlepack/"},next:{title:"@react-sigma/layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const c={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(c.h1,{id:"function-uselayoutcirclepack",children:"Function: useLayoutCirclepack()"}),"\n",(0,n.jsxs)(c.blockquote,{children:["\n",(0,n.jsxs)(c.p,{children:[(0,n.jsx)(c.strong,{children:"useLayoutCirclepack"}),"(",(0,n.jsx)(c.code,{children:"settings"}),"?): ",(0,n.jsx)(c.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsxs)(c.p,{children:["React hook that helps you to manage ",(0,n.jsx)(c.a,{href:"https://graphology.github.io/standard-library/layout.html#circlepack",children:"circlepack layout"}),"."]}),"\n",(0,n.jsx)(c.pre,{children:(0,n.jsx)(c.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCirclepack({...});\n"})}),"\n",(0,n.jsx)(c.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(c.p,{children:["\u2022 ",(0,n.jsx)(c.strong,{children:"settings?"}),": ",(0,n.jsx)(c.code,{children:"CirclePackLayoutOptions"})]}),"\n",(0,n.jsx)(c.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.code,{children:"object"})}),"\n",(0,n.jsx)(c.h3,{id:"assign",children:"assign()"}),"\n",(0,n.jsxs)(c.blockquote,{children:["\n",(0,n.jsxs)(c.p,{children:[(0,n.jsx)(c.strong,{children:"assign"}),": () => ",(0,n.jsx)(c.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(c.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.code,{children:"void"})}),"\n",(0,n.jsx)(c.h3,{id:"positions",children:"positions()"}),"\n",(0,n.jsxs)(c.blockquote,{children:["\n",(0,n.jsxs)(c.p,{children:[(0,n.jsx)(c.strong,{children:"positions"}),": () => ",(0,n.jsx)(c.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(c.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.code,{children:"object"})}),"\n",(0,n.jsx)(c.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(c.p,{children:(0,n.jsx)(c.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-circlepack/src/useLayoutCirclepack.ts#L13",children:"layout-circlepack/src/useLayoutCirclepack.ts:13"})})]})}function d(e={}){const{wrapper:c}={...(0,t.R)(),...e.components};return c?(0,n.jsx)(c,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},1184:(e,c,s)=>{s.d(c,{R:()=>r,x:()=>a});var n=s(4041);const t={},i=n.createContext(t);function r(e){const c=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(c):{...c,...e}}),[c,e])}function a(e){let c;return c=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(i.Provider,{value:c},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6c6c456.001d4c40.js b/assets/js/e6c6c456.7a07c152.js similarity index 88% rename from assets/js/e6c6c456.001d4c40.js rename to assets/js/e6c6c456.7a07c152.js index 434a43ff..b59d3170 100644 --- a/assets/js/e6c6c456.001d4c40.js +++ b/assets/js/e6c6c456.7a07c152.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7073],{8472:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>t,metadata:()=>i,toc:()=>a});var s=n(1085),o=n(1184);const t={},c="Function: useWorkerLayoutForce()",i={id:"api/layout-force/functions/useWorkerLayoutForce",title:"Function: useWorkerLayoutForce()",description:"useWorkerLayoutForce(settings): object",source:"@site/docs/api/layout-force/functions/useWorkerLayoutForce.md",sourceDirName:"api/layout-force/functions",slug:"/api/layout-force/functions/useWorkerLayoutForce",permalink:"/react-sigma/docs/api/layout-force/functions/useWorkerLayoutForce",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/functions/useWorkerLayoutForce.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useLayoutForce"},next:{title:"Type Alias: LayoutForceControlProps",permalink:"/react-sigma/docs/api/layout-force/type-aliases/LayoutForceControlProps"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"function-useworkerlayoutforce",children:"Function: useWorkerLayoutForce()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"useWorkerLayoutForce"}),"(",(0,s.jsx)(r.code,{children:"settings"}),"): ",(0,s.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["React hook that helps you to manage worker of ",(0,s.jsx)(r.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForce(...);\n"})}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"settings"}),": ",(0,s.jsx)(r.code,{children:"ForceLayoutSupervisorParameters"})]}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"object"})}),"\n",(0,s.jsx)(r.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"isRunning"}),": ",(0,s.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(r.h3,{id:"kill",children:"kill()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"kill"}),": () => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h3,{id:"start",children:"start()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"start"}),": () => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"stop"}),": () => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-force/src/useWorkerLayoutForce.ts#L13",children:"packages/layout-force/src/useWorkerLayoutForce.ts:13"})})]})}function d(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},1184:(e,r,n)=>{n.d(r,{R:()=>c,x:()=>i});var s=n(4041);const o={},t=s.createContext(o);function c(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[7073],{8472:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=n(1085),o=n(1184);const t={},i="Function: useWorkerLayoutForce()",c={id:"api/layout-force/functions/useWorkerLayoutForce",title:"Function: useWorkerLayoutForce()",description:"useWorkerLayoutForce(settings): object",source:"@site/docs/api/layout-force/functions/useWorkerLayoutForce.md",sourceDirName:"api/layout-force/functions",slug:"/api/layout-force/functions/useWorkerLayoutForce",permalink:"/react-sigma/docs/api/layout-force/functions/useWorkerLayoutForce",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-force/functions/useWorkerLayoutForce.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLayoutForce()",permalink:"/react-sigma/docs/api/layout-force/functions/useLayoutForce"},next:{title:"Type Alias: LayoutForceControlProps",permalink:"/react-sigma/docs/api/layout-force/type-aliases/LayoutForceControlProps"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"isRunning",id:"isrunning",level:3},{value:"kill()",id:"kill",level:3},{value:"Returns",id:"returns-1",level:4},{value:"start()",id:"start",level:3},{value:"Returns",id:"returns-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in",level:2}];function u(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"function-useworkerlayoutforce",children:"Function: useWorkerLayoutForce()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"useWorkerLayoutForce"}),"(",(0,s.jsx)(r.code,{children:"settings"}),"): ",(0,s.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(r.p,{children:["React hook that helps you to manage worker of ",(0,s.jsx)(r.a,{href:"https://graphology.github.io/standard-library/layout-force.html",children:"force layout"}),"."]}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"const { stop, start } = useWorkerLayoutForce(...);\n"})}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"settings"}),": ",(0,s.jsx)(r.code,{children:"ForceLayoutSupervisorParameters"})]}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"object"})}),"\n",(0,s.jsx)(r.h3,{id:"isrunning",children:"isRunning"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"isRunning"}),": ",(0,s.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(r.h3,{id:"kill",children:"kill()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"kill"}),": () => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h3,{id:"start",children:"start()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"start"}),": () => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h3,{id:"stop",children:"stop()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"stop"}),": () => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-force/src/useWorkerLayoutForce.ts#L13",children:"packages/layout-force/src/useWorkerLayoutForce.ts:13"})})]})}function d(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},1184:(e,r,n)=>{n.d(r,{R:()=>i,x:()=>c});var s=n(4041);const o={},t=s.createContext(o);function i(e){const r=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e82272c9.c9d8a6ec.js b/assets/js/e82272c9.5601235c.js similarity index 90% rename from assets/js/e82272c9.c9d8a6ec.js rename to assets/js/e82272c9.5601235c.js index ad0e8b3a..11691473 100644 --- a/assets/js/e82272c9.c9d8a6ec.js +++ b/assets/js/e82272c9.5601235c.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[6519],{3525:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=o(1085),r=o(1184);const i={},t="Interface: ControlsContainerProps",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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/ControlsContainerProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useSigmaContext()",permalink:"/react-sigma/docs/api/core/functions/useSigmaContext"},next:{title:"Interface: 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",blockquote:"blockquote",code:"code",h1:"h1",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.jsx)(n.h1,{id:"interface-controlscontainerprops",children:"Interface: ControlsContainerProps"}),"\n",(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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": ",(0,s.jsx)(n.code,{children:"ReactNode"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(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"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/components/controls/ControlsContainer.tsx#L18",children:"packages/core/src/components/controls/ControlsContainer.tsx:18"})})]})}function h(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([[6519],{3525:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=o(1085),r=o(1184);const i={},t="Interface: ControlsContainerProps",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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/interfaces/ControlsContainerProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useSigmaContext()",permalink:"/react-sigma/docs/api/core/functions/useSigmaContext"},next:{title:"Interface: 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",blockquote:"blockquote",code:"code",h1:"h1",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.jsx)(n.h1,{id:"interface-controlscontainerprops",children:"Interface: ControlsContainerProps"}),"\n",(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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"children"}),": ",(0,s.jsx)(n.code,{children:"ReactNode"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"className"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(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"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/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.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"style"}),": ",(0,s.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/components/controls/ControlsContainer.tsx#L18",children:"packages/core/src/components/controls/ControlsContainer.tsx:18"})})]})}function h(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.1c266271.js b/assets/js/e9d20596.7a934d3d.js similarity index 90% rename from assets/js/e9d20596.1c266271.js rename to assets/js/e9d20596.7a934d3d.js index f9aa5862..fd150b4b 100644 --- a/assets/js/e9d20596.1c266271.js +++ b/assets/js/e9d20596.7a934d3d.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[3379],{2256:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var o=r(1085),s=r(1184);const t={},i="Interface: WorkerLayoutControlProps",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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/interfaces/WorkerLayoutControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useWorkerLayoutFactory"},next:{title:"Type Alias: LayoutHook()\\",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook"}},c={},d=[{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:"start",id:"start",level:4},{value:"stop",id:"stop",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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-workerlayoutcontrolpropst",children:"Interface: WorkerLayoutControlProps"}),"\n",(0,o.jsxs)(n.p,{children:["Properties for ",(0,o.jsx)(n.code,{children:"WorkerLayoutControl"})," component"]}),"\n",(0,o.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"T"})]}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"autorunfor",children:"autoRunFor?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"autoRunFor"}),": ",(0,o.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Option to tell what we do when the component is mounted"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)("code",{children:"-1"})," means that we do nothing (it's the same as no value)"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)("code",{children:"0"})," means that we start the algo (and don't auto stop it)"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)("code",{children:"X"})," mans that we start the algo, and stop it after X milliseconds"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L45",children:"WorkerLayoutControl.tsx:45"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"children",children:"children?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"children"}),": [",(0,o.jsx)(n.code,{children:"Element"}),", ",(0,o.jsx)(n.code,{children:"Element"}),"]"]}),"\n"]}),"\n",(0,o.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,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-jsx",children:"\n <>\n Start\n Stop\n \n\n"})}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L60",children:"WorkerLayoutControl.tsx:60"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"classname",children:"className?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"className"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"HTML class"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L22",children:"WorkerLayoutControl.tsx:22"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"id"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"HTML id"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L17",children:"WorkerLayoutControl.tsx:17"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"labels"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,o.jsx)(n.h4,{id:"start",children:"start"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"start"}),": ",(0,o.jsx)(n.code,{children:"undefined"})," | ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"stop",children:"stop"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"stop"}),": ",(0,o.jsx)(n.code,{children:"undefined"})," | ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L66",children:"WorkerLayoutControl.tsx:66"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"layout",children:"layout"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"layout"}),": ",(0,o.jsx)(n.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",children:(0,o.jsx)(n.code,{children:"LayoutWorkerHook"})}),"<",(0,o.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The layout hook to use"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L32",children:"WorkerLayoutControl.tsx:32"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"settings"}),": ",(0,o.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Settings of the layout."}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-core/src/WorkerLayoutControl.tsx#L37",children:"WorkerLayoutControl.tsx:37"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"style",children:"style?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"style"}),": ",(0,o.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/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,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var o=r(4041);const s={},t=o.createContext(s);function i(e){const n=o.useContext(t);return o.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),o.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([[3379],{2256:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var o=r(1085),s=r(1184);const t={},i="Interface: WorkerLayoutControlProps",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:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-core/interfaces/WorkerLayoutControlProps.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useWorkerLayoutFactory()",permalink:"/react-sigma/docs/api/layout-core/functions/useWorkerLayoutFactory"},next:{title:"Type Alias: LayoutHook()\\",permalink:"/react-sigma/docs/api/layout-core/type-aliases/LayoutHook"}},d={},c=[{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:"start",id:"start",level:4},{value:"stop",id:"stop",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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-workerlayoutcontrolpropst",children:"Interface: WorkerLayoutControlProps"}),"\n",(0,o.jsxs)(n.p,{children:["Properties for ",(0,o.jsx)(n.code,{children:"WorkerLayoutControl"})," component"]}),"\n",(0,o.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"T"})]}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"autorunfor",children:"autoRunFor?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"autoRunFor"}),": ",(0,o.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Option to tell what we do when the component is mounted"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)("code",{children:"-1"})," means that we do nothing (it's the same as no value)"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)("code",{children:"0"})," means that we start the algo (and don't auto stop it)"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)("code",{children:"X"})," mans that we start the algo, and stop it after X milliseconds"]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L45",children:"WorkerLayoutControl.tsx:45"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"children",children:"children?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"children"}),": [",(0,o.jsx)(n.code,{children:"Element"}),", ",(0,o.jsx)(n.code,{children:"Element"}),"]"]}),"\n"]}),"\n",(0,o.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,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-jsx",children:"\n <>\n Start\n Stop\n \n\n"})}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L60",children:"WorkerLayoutControl.tsx:60"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"classname",children:"className?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"className"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"HTML class"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L22",children:"WorkerLayoutControl.tsx:22"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"id"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"HTML id"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L17",children:"WorkerLayoutControl.tsx:17"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"labels"}),": ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Map of the labels we use in the component.\nThis is usefull for I18N"}),"\n",(0,o.jsx)(n.h4,{id:"start",children:"start"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"start"}),": ",(0,o.jsx)(n.code,{children:"undefined"})," | ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"stop",children:"stop"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"stop"}),": ",(0,o.jsx)(n.code,{children:"undefined"})," | ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L66",children:"WorkerLayoutControl.tsx:66"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"layout",children:"layout"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"layout"}),": ",(0,o.jsx)(n.a,{href:"/react-sigma/docs/api/layout-core/type-aliases/LayoutWorkerHook",children:(0,o.jsx)(n.code,{children:"LayoutWorkerHook"})}),"<",(0,o.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The layout hook to use"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L32",children:"WorkerLayoutControl.tsx:32"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"settings"}),": ",(0,o.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Settings of the layout."}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-core/src/WorkerLayoutControl.tsx#L37",children:"WorkerLayoutControl.tsx:37"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"style",children:"style?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"style"}),": ",(0,o.jsx)(n.code,{children:"CSSProperties"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"HTML CSS style"}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/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,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},1184:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var o=r(4041);const s={},t=o.createContext(s);function i(e){const n=o.useContext(t);return o.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),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed19ce8b.45df3721.js b/assets/js/ed19ce8b.889b41df.js similarity index 97% rename from assets/js/ed19ce8b.45df3721.js rename to assets/js/ed19ce8b.889b41df.js index 5f05ed5c..a8186c8a 100644 --- a/assets/js/ed19ce8b.45df3721.js +++ b/assets/js/ed19ce8b.889b41df.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[788],{323:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=n(1085),r=n(1184);const i={},c="Function: useRegisterEvents()",o={id:"api/core/functions/useRegisterEvents",title:"Function: useRegisterEvents()",description:"useRegisterEvents\\(): (eventHandlers) => void",source:"@site/docs/api/core/functions/useRegisterEvents.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useRegisterEvents",permalink:"/react-sigma/docs/api/core/functions/useRegisterEvents",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useRegisterEvents.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLoadGraph()",permalink:"/react-sigma/docs/api/core/functions/useLoadGraph"},next:{title:"Function: useSetSettings()",permalink:"/react-sigma/docs/api/core/functions/useSetSettings"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"function-useregisterevents",children:"Function: useRegisterEvents()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"useRegisterEvents"}),"<",(0,t.jsx)(s.code,{children:"N"}),", ",(0,t.jsx)(s.code,{children:"E"}),", ",(0,t.jsx)(s.code,{children:"G"}),">(): (",(0,t.jsx)(s.code,{children:"eventHandlers"}),") => ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.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)(s.pre,{children:(0,t.jsx)(s.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)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"N"})," ",(0,t.jsx)(s.em,{children:"extends"})," ",(0,t.jsx)(s.code,{children:"Attributes"})," = ",(0,t.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"E"})," ",(0,t.jsx)(s.em,{children:"extends"})," ",(0,t.jsx)(s.code,{children:"Attributes"})," = ",(0,t.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"G"})," ",(0,t.jsx)(s.em,{children:"extends"})," ",(0,t.jsx)(s.code,{children:"Attributes"})," = ",(0,t.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"Function"})}),"\n",(0,t.jsx)(s.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"eventHandlers"}),": ",(0,t.jsx)(s.code,{children:"Partial"}),"<",(0,t.jsx)(s.a,{href:"/react-sigma/docs/api/core/type-aliases/EventHandlers",children:(0,t.jsx)(s.code,{children:"EventHandlers"})}),">"]}),"\n",(0,t.jsx)(s.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/useRegisterEvents.ts#L87",children:"packages/core/src/hooks/useRegisterEvents.ts:87"})})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var t=n(4041);const r={},i=t.createContext(r);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[788],{323:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=n(1085),r=n(1184);const i={},c="Function: useRegisterEvents()",o={id:"api/core/functions/useRegisterEvents",title:"Function: useRegisterEvents()",description:"useRegisterEvents\\(): (eventHandlers) => void",source:"@site/docs/api/core/functions/useRegisterEvents.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useRegisterEvents",permalink:"/react-sigma/docs/api/core/functions/useRegisterEvents",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useRegisterEvents.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useLoadGraph()",permalink:"/react-sigma/docs/api/core/functions/useLoadGraph"},next:{title:"Function: useSetSettings()",permalink:"/react-sigma/docs/api/core/functions/useSetSettings"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"function-useregisterevents",children:"Function: useRegisterEvents()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"useRegisterEvents"}),"<",(0,t.jsx)(s.code,{children:"N"}),", ",(0,t.jsx)(s.code,{children:"E"}),", ",(0,t.jsx)(s.code,{children:"G"}),">(): (",(0,t.jsx)(s.code,{children:"eventHandlers"}),") => ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.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)(s.pre,{children:(0,t.jsx)(s.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)(s.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"N"})," ",(0,t.jsx)(s.em,{children:"extends"})," ",(0,t.jsx)(s.code,{children:"Attributes"})," = ",(0,t.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"E"})," ",(0,t.jsx)(s.em,{children:"extends"})," ",(0,t.jsx)(s.code,{children:"Attributes"})," = ",(0,t.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"G"})," ",(0,t.jsx)(s.em,{children:"extends"})," ",(0,t.jsx)(s.code,{children:"Attributes"})," = ",(0,t.jsx)(s.code,{children:"Attributes"})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"Function"})}),"\n",(0,t.jsx)(s.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"eventHandlers"}),": ",(0,t.jsx)(s.code,{children:"Partial"}),"<",(0,t.jsx)(s.a,{href:"/react-sigma/docs/api/core/type-aliases/EventHandlers",children:(0,t.jsx)(s.code,{children:"EventHandlers"})}),">"]}),"\n",(0,t.jsx)(s.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/useRegisterEvents.ts#L87",children:"packages/core/src/hooks/useRegisterEvents.ts:87"})})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1184:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var t=n(4041);const r={},i=t.createContext(r);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f097fad7.08104210.js b/assets/js/f097fad7.de701ad5.js similarity index 85% rename from assets/js/f097fad7.08104210.js rename to assets/js/f097fad7.de701ad5.js index 609d554f..a25a0ae0 100644 --- a/assets/js/f097fad7.08104210.js +++ b/assets/js/f097fad7.de701ad5.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[3829],{5646:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var n=s(1085),a=s(1184);const r={},i="Type Alias: EventHandlers",o={id:"api/core/type-aliases/EventHandlers",title:"Type Alias: EventHandlers",description:"EventHandlers: SigmaEvents & TouchCaptorEvents & MouseCaptorEvents & CameraEvents",source:"@site/docs/api/core/type-aliases/EventHandlers.md",sourceDirName:"api/core/type-aliases",slug:"/api/core/type-aliases/EventHandlers",permalink:"/react-sigma/docs/api/core/type-aliases/EventHandlers",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/type-aliases/EventHandlers.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps"},next:{title:"Type Alias: GraphType\\",permalink:"/react-sigma/docs/api/core/type-aliases/GraphType"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-eventhandlers",children:"Type Alias: EventHandlers"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"EventHandlers"}),": ",(0,n.jsx)(t.code,{children:"SigmaEvents"})," & ",(0,n.jsx)(t.code,{children:"TouchCaptorEvents"})," & ",(0,n.jsx)(t.code,{children:"MouseCaptorEvents"})," & ",(0,n.jsx)(t.code,{children:"CameraEvents"})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Sigma's events"}),"\n",(0,n.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/types.ts#L7",children:"packages/core/src/types.ts:7"})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>o});var n=s(4041);const a={},r=n.createContext(a);function i(e){const t=n.useContext(r);return n.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(a):e.components||a:i(e.components),n.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([[3829],{5646:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var n=s(1085),a=s(1184);const r={},i="Type Alias: EventHandlers",o={id:"api/core/type-aliases/EventHandlers",title:"Type Alias: EventHandlers",description:"EventHandlers: SigmaEvents & TouchCaptorEvents & MouseCaptorEvents & CameraEvents",source:"@site/docs/api/core/type-aliases/EventHandlers.md",sourceDirName:"api/core/type-aliases",slug:"/api/core/type-aliases/EventHandlers",permalink:"/react-sigma/docs/api/core/type-aliases/EventHandlers",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/type-aliases/EventHandlers.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Interface: ZoomControlProps",permalink:"/react-sigma/docs/api/core/interfaces/ZoomControlProps"},next:{title:"Type Alias: GraphType\\",permalink:"/react-sigma/docs/api/core/type-aliases/GraphType"}},c={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-eventhandlers",children:"Type Alias: EventHandlers"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"EventHandlers"}),": ",(0,n.jsx)(t.code,{children:"SigmaEvents"})," & ",(0,n.jsx)(t.code,{children:"TouchCaptorEvents"})," & ",(0,n.jsx)(t.code,{children:"MouseCaptorEvents"})," & ",(0,n.jsx)(t.code,{children:"CameraEvents"})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Sigma's events"}),"\n",(0,n.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/types.ts#L7",children:"packages/core/src/types.ts:7"})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>o});var n=s(4041);const a={},r=n.createContext(a);function i(e){const t=n.useContext(r);return n.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(a):e.components||a:i(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f11c0912.3fb0701f.js b/assets/js/f11c0912.4786b74f.js similarity index 96% rename from assets/js/f11c0912.3fb0701f.js rename to assets/js/f11c0912.4786b74f.js index 4bddd242..a5418d28 100644 --- a/assets/js/f11c0912.3fb0701f.js +++ b/assets/js/f11c0912.4786b74f.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2388],{4668:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>u});var n=s(1085),t=s(1184);const i={},c="Function: useLayoutCircular()",a={id:"api/layout-circular/functions/useLayoutCircular",title:"Function: useLayoutCircular()",description:"useLayoutCircular(settings?): object",source:"@site/docs/api/layout-circular/functions/useLayoutCircular.md",sourceDirName:"api/layout-circular/functions",slug:"/api/layout-circular/functions/useLayoutCircular",permalink:"/react-sigma/docs/api/layout-circular/functions/useLayoutCircular",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-circular/functions/useLayoutCircular.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"},next:{title:"@react-sigma/layout-core",permalink:"/react-sigma/docs/api/layout-core/"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"function-uselayoutcircular",children:"Function: useLayoutCircular()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"useLayoutCircular"}),"(",(0,n.jsx)(r.code,{children:"settings"}),"?): ",(0,n.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["React hook that helps you to manage ",(0,n.jsx)(r.a,{href:"https://graphology.github.io/standard-library/layout.html#circular",children:"circle layout"}),"."]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCircular(...);\n"})}),"\n",(0,n.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"settings?"}),": ",(0,n.jsx)(r.code,{children:"CircularLayoutOptions"})]}),"\n",(0,n.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"object"})}),"\n",(0,n.jsx)(r.h3,{id:"assign",children:"assign()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"assign"}),": () => ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h3,{id:"positions",children:"positions()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"positions"}),": () => ",(0,n.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"object"})}),"\n",(0,n.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/sim51/react-sigma/blob/2f28f3dca0636df638110299f1bcf9237e156b56/packages/layout-circular/src/useLayoutCircular.ts#L13",children:"layout-circular/src/useLayoutCircular.ts:13"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1184:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>a});var n=s(4041);const t={},i=n.createContext(t);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[2388],{4668:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>u});var n=s(1085),t=s(1184);const i={},c="Function: useLayoutCircular()",a={id:"api/layout-circular/functions/useLayoutCircular",title:"Function: useLayoutCircular()",description:"useLayoutCircular(settings?): object",source:"@site/docs/api/layout-circular/functions/useLayoutCircular.md",sourceDirName:"api/layout-circular/functions",slug:"/api/layout-circular/functions/useLayoutCircular",permalink:"/react-sigma/docs/api/layout-circular/functions/useLayoutCircular",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/layout-circular/functions/useLayoutCircular.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"@react-sigma/layout-circular",permalink:"/react-sigma/docs/api/layout-circular/"},next:{title:"@react-sigma/layout-core",permalink:"/react-sigma/docs/api/layout-core/"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"assign()",id:"assign",level:3},{value:"Returns",id:"returns-1",level:4},{value:"positions()",id:"positions",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"function-uselayoutcircular",children:"Function: useLayoutCircular()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"useLayoutCircular"}),"(",(0,n.jsx)(r.code,{children:"settings"}),"?): ",(0,n.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["React hook that helps you to manage ",(0,n.jsx)(r.a,{href:"https://graphology.github.io/standard-library/layout.html#circular",children:"circle layout"}),"."]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-typescript",children:"const { positions, assign } = useLayoutCircular(...);\n"})}),"\n",(0,n.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"settings?"}),": ",(0,n.jsx)(r.code,{children:"CircularLayoutOptions"})]}),"\n",(0,n.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"object"})}),"\n",(0,n.jsx)(r.h3,{id:"assign",children:"assign()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"assign"}),": () => ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h3,{id:"positions",children:"positions()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"positions"}),": () => ",(0,n.jsx)(r.code,{children:"object"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"object"})}),"\n",(0,n.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/sim51/react-sigma/blob/966d73d06bfe543ae3095d45b812c76776af574e/packages/layout-circular/src/useLayoutCircular.ts#L13",children:"layout-circular/src/useLayoutCircular.ts:13"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1184:(e,r,s)=>{s.d(r,{R:()=>c,x:()=>a});var n=s(4041);const t={},i=n.createContext(t);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fe3b803a.4076a911.js b/assets/js/fe3b803a.46a0d0bb.js similarity index 97% rename from assets/js/fe3b803a.4076a911.js rename to assets/js/fe3b803a.46a0d0bb.js index ed1d43a7..acb331aa 100644 --- a/assets/js/fe3b803a.4076a911.js +++ b/assets/js/fe3b803a.46a0d0bb.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_react_sigma_website=self.webpackChunk_react_sigma_website||[]).push([[1131],{815:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=n(1085),i=n(1184);const r={},c="Function: useSetSettings()",o={id:"api/core/functions/useSetSettings",title:"Function: useSetSettings()",description:"useSetSettings\\(): (newSettings) => void",source:"@site/docs/api/core/functions/useSetSettings.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useSetSettings",permalink:"/react-sigma/docs/api/core/functions/useSetSettings",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useSetSettings.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useRegisterEvents()",permalink:"/react-sigma/docs/api/core/functions/useRegisterEvents"},next:{title:"Function: useSigma()",permalink:"/react-sigma/docs/api/core/functions/useSigma"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-usesetsettings",children:"Function: useSetSettings()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"useSetSettings"}),"<",(0,s.jsx)(t.code,{children:"N"}),", ",(0,s.jsx)(t.code,{children:"E"}),", ",(0,s.jsx)(t.code,{children:"G"}),">(): (",(0,s.jsx)(t.code,{children:"newSettings"}),") => ",(0,s.jsx)(t.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"React hook that helps you to update Sigma\u2019s settings."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const setSettings = useSetSettings();\n...\nuseEffect(() => {\n setSettings({\n hideEdgesOnMove: true,\n hideLabelsOnMove: true,\n });\n}, []);\n"})}),"\n",(0,s.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"N"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.code,{children:"Attributes"})," = ",(0,s.jsx)(t.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"E"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.code,{children:"Attributes"})," = ",(0,s.jsx)(t.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"G"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.code,{children:"Attributes"})," = ",(0,s.jsx)(t.code,{children:"Attributes"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Function"})}),"\n",(0,s.jsx)(t.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"newSettings"}),": ",(0,s.jsx)(t.code,{children:"Partial"}),"<",(0,s.jsx)(t.code,{children:"Settings"}),"<",(0,s.jsx)(t.code,{children:"N"}),", ",(0,s.jsx)(t.code,{children:"E"}),", ",(0,s.jsx)(t.code,{children:"G"}),">>"]}),"\n",(0,s.jsx)(t.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"void"})}),"\n",(0,s.jsx)(t.h2,{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/2f28f3dca0636df638110299f1bcf9237e156b56/packages/core/src/hooks/useSetSettings.ts#L22",children:"packages/core/src/hooks/useSetSettings.ts:22"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var s=n(4041);const i={},r=s.createContext(i);function c(e){const t=s.useContext(r);return s.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(i):e.components||i:c(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([[1131],{815:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=n(1085),i=n(1184);const r={},c="Function: useSetSettings()",o={id:"api/core/functions/useSetSettings",title:"Function: useSetSettings()",description:"useSetSettings\\(): (newSettings) => void",source:"@site/docs/api/core/functions/useSetSettings.md",sourceDirName:"api/core/functions",slug:"/api/core/functions/useSetSettings",permalink:"/react-sigma/docs/api/core/functions/useSetSettings",draft:!1,unlisted:!1,editUrl:"https://github.com/sim51/react-sigma/tree/main/packages/website/docs/api/core/functions/useSetSettings.md",tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Function: useRegisterEvents()",permalink:"/react-sigma/docs/api/core/functions/useRegisterEvents"},next:{title:"Function: useSigma()",permalink:"/react-sigma/docs/api/core/functions/useSigma"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-usesetsettings",children:"Function: useSetSettings()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"useSetSettings"}),"<",(0,s.jsx)(t.code,{children:"N"}),", ",(0,s.jsx)(t.code,{children:"E"}),", ",(0,s.jsx)(t.code,{children:"G"}),">(): (",(0,s.jsx)(t.code,{children:"newSettings"}),") => ",(0,s.jsx)(t.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"React hook that helps you to update Sigma\u2019s settings."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const setSettings = useSetSettings();\n...\nuseEffect(() => {\n setSettings({\n hideEdgesOnMove: true,\n hideLabelsOnMove: true,\n });\n}, []);\n"})}),"\n",(0,s.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"N"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.code,{children:"Attributes"})," = ",(0,s.jsx)(t.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"E"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.code,{children:"Attributes"})," = ",(0,s.jsx)(t.code,{children:"Attributes"})]}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"G"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.code,{children:"Attributes"})," = ",(0,s.jsx)(t.code,{children:"Attributes"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"Function"})}),"\n",(0,s.jsx)(t.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"newSettings"}),": ",(0,s.jsx)(t.code,{children:"Partial"}),"<",(0,s.jsx)(t.code,{children:"Settings"}),"<",(0,s.jsx)(t.code,{children:"N"}),", ",(0,s.jsx)(t.code,{children:"E"}),", ",(0,s.jsx)(t.code,{children:"G"}),">>"]}),"\n",(0,s.jsx)(t.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"void"})}),"\n",(0,s.jsx)(t.h2,{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/966d73d06bfe543ae3095d45b812c76776af574e/packages/core/src/hooks/useSetSettings.ts#L22",children:"packages/core/src/hooks/useSetSettings.ts:22"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var s=n(4041);const i={},r=s.createContext(i);function c(e){const t=s.useContext(r);return s.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(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.339cf23b.js b/assets/js/runtime~main.c9df847b.js similarity index 55% rename from assets/js/runtime~main.339cf23b.js rename to assets/js/runtime~main.c9df847b.js index bb4b5dd6..e8ea239f 100644 --- a/assets/js/runtime~main.339cf23b.js +++ b/assets/js/runtime~main.c9df847b.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,d,c,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,r.amdD=function(){throw new Error("define cannot be used indirect")},r.amdO={},e=[],r.O=(a,d,c,f)=>{if(!d){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[d,c,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({289:"94632c8a",701:"0e29f09e",788:"ed19ce8b",819:"6f8401eb",958:"0abc1b57",1131:"fe3b803a",1235:"a7456010",1244:"127e2a23",1272:"735d0569",1284:"406179f6",1373:"700704ff",1403:"36d28def",1441:"2c32c100",1459:"958d1a80",1462:"9ff21ef4",1531:"7267a26e",1811:"737f273a",1852:"50c0544f",2063:"4d2c4bb1",2388:"f11c0912",2711:"1aa56bec",2765:"32dd47bd",2799:"999d5064",2881:"f7d9daf5",2885:"a1f74bf5",2907:"22f670d9",3055:"eec79c8d",3379:"e9d20596",3592:"566af407",3829:"f097fad7",3969:"a6d01e9f",4583:"1df93b7f",4970:"23db31aa",5146:"47a287a0",5279:"84db464d",5328:"b32aa62f",5362:"e60724d1",5378:"b025ee8f",5482:"6c60958d",5618:"4c3db254",5742:"aba21aa0",5773:"5b5d3e9c",5823:"3e23a349",5989:"8e6581c0",6217:"c6c56b9b",6224:"28066f65",6519:"e82272c9",6725:"4c8499be",6809:"a8addf22",6937:"cc19ab3b",7016:"6c3cbc8a",7073:"e6c6c456",7098:"a7bd4aaa",7186:"b5bbf372",7624:"5fbc5cf1",7759:"d0955971",7784:"28a50278",7804:"f744d675",7919:"09a6fb8d",8070:"0480b142",8387:"f822d16e",8401:"17896441",8508:"177d4b79",8770:"a2f529ce",8795:"b94983b7",9048:"a94703ab",9266:"86602c7e",9405:"c7bdaeff",9619:"71d6bb1a",9647:"5e95c892",9653:"de170a46"}[e]||e)+"."+{289:"ea0936ce",548:"d8393c59",701:"624fa5a6",788:"45df3721",819:"fd149683",958:"d6f4430a",1131:"4076a911",1235:"62a0ba21",1244:"7166b7c1",1272:"3437dca3",1284:"7646aabb",1373:"01fa10f7",1403:"58c862cf",1441:"2b105067",1459:"4bc95d93",1462:"22b8b346",1531:"58b5170f",1811:"06a69050",1852:"4b397317",2063:"0aa42569",2388:"3fb0701f",2711:"1824fbbd",2765:"5b1c869f",2799:"b46b1db7",2881:"8b178b17",2885:"632d0474",2907:"415b92ac",2995:"db1b078a",3055:"330d995e",3379:"1c266271",3592:"104d429c",3724:"7ce42cfe",3829:"08104210",3969:"6f55917b",4506:"26e76f51",4583:"031d43b3",4970:"52cbdeff",5146:"1c9fe0b8",5279:"4160ebf5",5328:"a9d54cc4",5362:"4d555e1c",5378:"9d5e5490",5482:"edda47e7",5611:"446341c6",5618:"36857124",5723:"874992df",5742:"b8b2ef8f",5773:"faf8d2ee",5823:"4e5ee3d9",5989:"c9fca975",6217:"d732032f",6224:"ecf49010",6519:"c9d8a6ec",6725:"30b85404",6809:"ca4c0cc1",6937:"8dd06ffe",7016:"c1cb58a6",7073:"001d4c40",7098:"b79bba6a",7186:"1f4600ca",7624:"3a316252",7759:"d85be16f",7784:"b66247ab",7803:"a306a702",7804:"ad74098d",7919:"0dea65f9",8070:"4d890942",8147:"4dac9a28",8387:"ee88cab2",8401:"1799e2c4",8508:"e9ff814d",8770:"e3ebea51",8795:"ba87ef7b",9048:"71ff6267",9266:"9abe853f",9405:"6acad953",9619:"c03c2b83",9647:"6f8d9ca7",9653:"7679a508"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},f="@react-sigma/website:",r.l=(e,a,d,b)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(d))),a)return a(d)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/react-sigma/",r.gca=function(e){return e={17896441:"8401","94632c8a":"289","0e29f09e":"701",ed19ce8b:"788","6f8401eb":"819","0abc1b57":"958",fe3b803a:"1131",a7456010:"1235","127e2a23":"1244","735d0569":"1272","406179f6":"1284","700704ff":"1373","36d28def":"1403","2c32c100":"1441","958d1a80":"1459","9ff21ef4":"1462","7267a26e":"1531","737f273a":"1811","50c0544f":"1852","4d2c4bb1":"2063",f11c0912:"2388","1aa56bec":"2711","32dd47bd":"2765","999d5064":"2799",f7d9daf5:"2881",a1f74bf5:"2885","22f670d9":"2907",eec79c8d:"3055",e9d20596:"3379","566af407":"3592",f097fad7:"3829",a6d01e9f:"3969","1df93b7f":"4583","23db31aa":"4970","47a287a0":"5146","84db464d":"5279",b32aa62f:"5328",e60724d1:"5362",b025ee8f:"5378","6c60958d":"5482","4c3db254":"5618",aba21aa0:"5742","5b5d3e9c":"5773","3e23a349":"5823","8e6581c0":"5989",c6c56b9b:"6217","28066f65":"6224",e82272c9:"6519","4c8499be":"6725",a8addf22:"6809",cc19ab3b:"6937","6c3cbc8a":"7016",e6c6c456:"7073",a7bd4aaa:"7098",b5bbf372:"7186","5fbc5cf1":"7624",d0955971:"7759","28a50278":"7784",f744d675:"7804","09a6fb8d":"7919","0480b142":"8070",f822d16e:"8387","177d4b79":"8508",a2f529ce:"8770",b94983b7:"8795",a94703ab:"9048","86602c7e":"9266",c7bdaeff:"9405","71d6bb1a":"9619","5e95c892":"9647",de170a46:"9653"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,d)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)d.push(c[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((d,f)=>c=e[a]=[d,f]));d.push(c[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var c,f,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(d);n{"use strict";var e,a,d,f,c,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,r.amdD=function(){throw new Error("define cannot be used indirect")},r.amdO={},e=[],r.O=(a,d,f,c)=>{if(!d){var b=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,f,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(c,b),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({289:"94632c8a",701:"0e29f09e",788:"ed19ce8b",819:"6f8401eb",958:"0abc1b57",1131:"fe3b803a",1235:"a7456010",1244:"127e2a23",1272:"735d0569",1284:"406179f6",1373:"700704ff",1403:"36d28def",1441:"2c32c100",1459:"958d1a80",1462:"9ff21ef4",1531:"7267a26e",1811:"737f273a",1852:"50c0544f",2063:"4d2c4bb1",2388:"f11c0912",2711:"1aa56bec",2765:"32dd47bd",2799:"999d5064",2881:"f7d9daf5",2885:"a1f74bf5",2907:"22f670d9",3055:"eec79c8d",3379:"e9d20596",3592:"566af407",3829:"f097fad7",3969:"a6d01e9f",4583:"1df93b7f",4970:"23db31aa",5146:"47a287a0",5279:"84db464d",5328:"b32aa62f",5362:"e60724d1",5378:"b025ee8f",5482:"6c60958d",5618:"4c3db254",5742:"aba21aa0",5773:"5b5d3e9c",5823:"3e23a349",5989:"8e6581c0",6217:"c6c56b9b",6224:"28066f65",6519:"e82272c9",6725:"4c8499be",6809:"a8addf22",6937:"cc19ab3b",7016:"6c3cbc8a",7073:"e6c6c456",7098:"a7bd4aaa",7186:"b5bbf372",7624:"5fbc5cf1",7759:"d0955971",7784:"28a50278",7804:"f744d675",7919:"09a6fb8d",8070:"0480b142",8387:"f822d16e",8401:"17896441",8508:"177d4b79",8770:"a2f529ce",8795:"b94983b7",9048:"a94703ab",9266:"86602c7e",9405:"c7bdaeff",9619:"71d6bb1a",9647:"5e95c892",9653:"de170a46"}[e]||e)+"."+{289:"d6256684",548:"d8393c59",701:"624fa5a6",788:"889b41df",819:"202ad399",958:"99454050",1131:"46a0d0bb",1235:"62a0ba21",1244:"f62b07eb",1272:"3437dca3",1284:"715e34f1",1373:"1f800a7c",1403:"7bc4a68d",1441:"2b105067",1459:"4bc95d93",1462:"33336284",1531:"8d764956",1811:"06a69050",1852:"e545c423",2063:"de706d7d",2388:"4786b74f",2711:"1824fbbd",2765:"a3a0731a",2799:"79b8cea9",2881:"8b178b17",2885:"632d0474",2907:"415b92ac",2995:"db1b078a",3055:"330d995e",3379:"7a934d3d",3592:"104d429c",3724:"7ce42cfe",3829:"de701ad5",3969:"6f55917b",4506:"26e76f51",4583:"031d43b3",4970:"cd254b13",5146:"3d62984a",5279:"3862c5b1",5328:"a9d54cc4",5362:"a83bcb85",5378:"8025b69c",5482:"3d5d69bd",5611:"446341c6",5618:"c5192b9c",5723:"874992df",5742:"b8b2ef8f",5773:"b738d9c0",5823:"4e5ee3d9",5989:"0a166768",6217:"6c5cddb7",6224:"3cd23b36",6519:"5601235c",6725:"5414d19e",6809:"380ffa34",6937:"1520a63e",7016:"c1cb58a6",7073:"7a07c152",7098:"b79bba6a",7186:"a17f50b9",7624:"3a316252",7759:"72135119",7784:"0c9c3659",7803:"a306a702",7804:"ad74098d",7919:"115640f5",8070:"4d890942",8147:"4dac9a28",8387:"ee88cab2",8401:"1799e2c4",8508:"a8e93bcb",8770:"e3ebea51",8795:"75fe6c6e",9048:"71ff6267",9266:"9abe853f",9405:"b41f18dd",9619:"bdfc5307",9647:"6f8d9ca7",9653:"09850044"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},c="@react-sigma/website:",r.l=(e,a,d,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/react-sigma/",r.gca=function(e){return e={17896441:"8401","94632c8a":"289","0e29f09e":"701",ed19ce8b:"788","6f8401eb":"819","0abc1b57":"958",fe3b803a:"1131",a7456010:"1235","127e2a23":"1244","735d0569":"1272","406179f6":"1284","700704ff":"1373","36d28def":"1403","2c32c100":"1441","958d1a80":"1459","9ff21ef4":"1462","7267a26e":"1531","737f273a":"1811","50c0544f":"1852","4d2c4bb1":"2063",f11c0912:"2388","1aa56bec":"2711","32dd47bd":"2765","999d5064":"2799",f7d9daf5:"2881",a1f74bf5:"2885","22f670d9":"2907",eec79c8d:"3055",e9d20596:"3379","566af407":"3592",f097fad7:"3829",a6d01e9f:"3969","1df93b7f":"4583","23db31aa":"4970","47a287a0":"5146","84db464d":"5279",b32aa62f:"5328",e60724d1:"5362",b025ee8f:"5378","6c60958d":"5482","4c3db254":"5618",aba21aa0:"5742","5b5d3e9c":"5773","3e23a349":"5823","8e6581c0":"5989",c6c56b9b:"6217","28066f65":"6224",e82272c9:"6519","4c8499be":"6725",a8addf22:"6809",cc19ab3b:"6937","6c3cbc8a":"7016",e6c6c456:"7073",a7bd4aaa:"7098",b5bbf372:"7186","5fbc5cf1":"7624",d0955971:"7759","28a50278":"7784",f744d675:"7804","09a6fb8d":"7919","0480b142":"8070",f822d16e:"8387","177d4b79":"8508",a2f529ce:"8770",b94983b7:"8795",a94703ab:"9048","86602c7e":"9266",c7bdaeff:"9405","71d6bb1a":"9619","5e95c892":"9647",de170a46:"9653"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,d)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)d.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>f=e[a]=[d,c]));d.push(f[2]=c);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var c=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+b+")",t.name="ChunkLoadError",t.type=c,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var f,c,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(d);n Function: ControlsContainer() | React Sigma - + @@ -23,6 +23,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/FullScreenControl/index.html b/docs/api/core/functions/FullScreenControl/index.html index c3da10ca..b13f9e8b 100644 --- a/docs/api/core/functions/FullScreenControl/index.html +++ b/docs/api/core/functions/FullScreenControl/index.html @@ -5,7 +5,7 @@ Function: FullScreenControl() | React Sigma - + @@ -22,6 +22,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/SearchControl/index.html b/docs/api/core/functions/SearchControl/index.html index ae03e02e..b8db37d1 100644 --- a/docs/api/core/functions/SearchControl/index.html +++ b/docs/api/core/functions/SearchControl/index.html @@ -5,7 +5,7 @@ Function: SearchControl() | React Sigma - + @@ -24,6 +24,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/SigmaContainer/index.html b/docs/api/core/functions/SigmaContainer/index.html index d8f6e620..70eedc60 100644 --- a/docs/api/core/functions/SigmaContainer/index.html +++ b/docs/api/core/functions/SigmaContainer/index.html @@ -5,7 +5,7 @@ Function: SigmaContainer() | React Sigma - + @@ -22,6 +22,6 @@

ParametersReturns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/ZoomControl/index.html b/docs/api/core/functions/ZoomControl/index.html index 45847fa6..7eb15fb3 100644 --- a/docs/api/core/functions/ZoomControl/index.html +++ b/docs/api/core/functions/ZoomControl/index.html @@ -5,7 +5,7 @@ Function: ZoomControl() | React Sigma - + @@ -27,6 +27,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/getUniqueKey/index.html b/docs/api/core/functions/getUniqueKey/index.html index 3fe47bfe..3022b2d1 100644 --- a/docs/api/core/functions/getUniqueKey/index.html +++ b/docs/api/core/functions/getUniqueKey/index.html @@ -5,7 +5,7 @@ Function: getUniqueKey() | React Sigma - + @@ -16,6 +16,6 @@

Returns​

string

Defined in​

-

packages/core/src/utils.ts:1

+

packages/core/src/utils.ts:1

\ No newline at end of file diff --git a/docs/api/core/functions/isEqual/index.html b/docs/api/core/functions/isEqual/index.html index 405df27c..667a7038 100644 --- a/docs/api/core/functions/isEqual/index.html +++ b/docs/api/core/functions/isEqual/index.html @@ -5,7 +5,7 @@ Function: isEqual() | React Sigma - + @@ -19,6 +19,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/functions/useCamera/index.html b/docs/api/core/functions/useCamera/index.html index 6c42d429..e3667267 100644 --- a/docs/api/core/functions/useCamera/index.html +++ b/docs/api/core/functions/useCamera/index.html @@ -5,7 +5,7 @@ Function: useCamera() | React Sigma - + @@ -62,6 +62,6 @@

ParametersReturns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/useFullScreen/index.html b/docs/api/core/functions/useFullScreen/index.html index b66ce52a..4704c73c 100644 --- a/docs/api/core/functions/useFullScreen/index.html +++ b/docs/api/core/functions/useFullScreen/index.html @@ -5,7 +5,7 @@ Function: useFullScreen() | React Sigma - + @@ -30,6 +30,6 @@

toggle()Returns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/useLoadGraph/index.html b/docs/api/core/functions/useLoadGraph/index.html index 6abd38bc..01d75c59 100644 --- a/docs/api/core/functions/useLoadGraph/index.html +++ b/docs/api/core/functions/useLoadGraph/index.html @@ -5,7 +5,7 @@ Function: useLoadGraph() | React Sigma - + @@ -29,6 +29,6 @@

ParametersReturns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/useRegisterEvents/index.html b/docs/api/core/functions/useRegisterEvents/index.html index 8fd213db..bacb35bd 100644 --- a/docs/api/core/functions/useRegisterEvents/index.html +++ b/docs/api/core/functions/useRegisterEvents/index.html @@ -5,7 +5,7 @@ Function: useRegisterEvents() | React Sigma - + @@ -27,6 +27,6 @@

ParametersReturns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/useSetSettings/index.html b/docs/api/core/functions/useSetSettings/index.html index 22e50a3d..0dd01335 100644 --- a/docs/api/core/functions/useSetSettings/index.html +++ b/docs/api/core/functions/useSetSettings/index.html @@ -5,7 +5,7 @@ Function: useSetSettings() | React Sigma - + @@ -26,6 +26,6 @@

ParametersReturns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/useSigma/index.html b/docs/api/core/functions/useSigma/index.html index d353ae10..0d0c6eea 100644 --- a/docs/api/core/functions/useSigma/index.html +++ b/docs/api/core/functions/useSigma/index.html @@ -5,7 +5,7 @@ Function: useSigma() | React Sigma - + @@ -22,6 +22,6 @@

Type Paramet

Returns​

Sigma<N, E, G>

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/functions/useSigmaContext/index.html b/docs/api/core/functions/useSigmaContext/index.html index 568dda56..2b6e58ad 100644 --- a/docs/api/core/functions/useSigmaContext/index.html +++ b/docs/api/core/functions/useSigmaContext/index.html @@ -5,7 +5,7 @@ Function: useSigmaContext() | React Sigma - + @@ -23,6 +23,6 @@

Type Paramet

Returns​

SigmaContextInterface<N, E, G>

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/core/index.html b/docs/api/core/index.html index 35fe12aa..f9af1897 100644 --- a/docs/api/core/index.html +++ b/docs/api/core/index.html @@ -5,7 +5,7 @@ @react-sigma/core | React Sigma - + diff --git a/docs/api/core/interfaces/ControlsContainerProps/index.html b/docs/api/core/interfaces/ControlsContainerProps/index.html index a11bd0d3..c76b046f 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 - + @@ -17,7 +17,7 @@

children?Defined in​

-

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

+

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

className?​

@@ -25,7 +25,7 @@

className?

HTML class

Defined in​

-

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

+

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

id?​

@@ -33,7 +33,7 @@

id?

HTML id

Defined in​

-

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

+

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

position?​

@@ -41,7 +41,7 @@

position?Defined in​

-

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

+

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

style?​

@@ -49,6 +49,6 @@

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 299e8b58..1a3f5165 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 - + @@ -21,7 +21,7 @@

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

Defined in​

-

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

+

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

className?​

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

className?

HTML class

Defined in​

-

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

+

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

container?​

@@ -37,7 +37,7 @@

container?

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?​

@@ -45,7 +45,7 @@

id?

HTML id

Defined in​

-

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

+

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

labels?​

@@ -62,7 +62,7 @@

exitDefined in​

-

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

+

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

style?​

@@ -70,6 +70,6 @@

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 3bbdaaf5..d06ef466 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 - + @@ -18,7 +18,7 @@

className?

HTML class

Defined in​

-

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

+

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

id?​

@@ -26,7 +26,7 @@

id?

HTML id

Defined in​

-

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

+

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

labels?​

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

textDefined in​

-

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

+

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

style?​

@@ -51,6 +51,6 @@

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 2f87f971..65f318d1 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 - + @@ -22,7 +22,7 @@

className?

HTML class

Defined in​

-

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

+

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

graph?​

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

graph?Defined in​

-

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

+

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

id?​

@@ -38,7 +38,7 @@

id?

HTML id

Defined in​

-

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

+

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

settings?​

@@ -46,7 +46,7 @@

settings?Defined in​

-

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

+

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

style?​

@@ -54,6 +54,6 @@

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 3f600f4a..290c0f99 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 - + @@ -20,13 +20,13 @@

containercontainer: HTMLElement

Defined in​

-

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

+

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

sigma​

sigma: Sigma<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 8ccea0d7..e5e99357 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 - + @@ -18,7 +18,7 @@

animationD

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?​

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

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?​

@@ -37,7 +37,7 @@

className?

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?​

@@ -58,7 +58,7 @@

zoomOutDefined in​

-

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

+

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

style?​

@@ -66,6 +66,6 @@

style?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/core/type-aliases/EventHandlers/index.html b/docs/api/core/type-aliases/EventHandlers/index.html index 43a598aa..7f15e7cc 100644 --- a/docs/api/core/type-aliases/EventHandlers/index.html +++ b/docs/api/core/type-aliases/EventHandlers/index.html @@ -5,7 +5,7 @@ Type Alias: EventHandlers | React Sigma - + @@ -15,6 +15,6 @@

Sigma's events

Defined in​

-

packages/core/src/types.ts:7

+

packages/core/src/types.ts:7

\ No newline at end of file diff --git a/docs/api/core/type-aliases/GraphType/index.html b/docs/api/core/type-aliases/GraphType/index.html index 72bb5e56..cfd07df5 100644 --- a/docs/api/core/type-aliases/GraphType/index.html +++ b/docs/api/core/type-aliases/GraphType/index.html @@ -5,7 +5,7 @@ Type Alias: GraphType\<N, E, G\> | React Sigma - + @@ -18,6 +18,6 @@

Type Paramet

• E extends Attributes = Attributes

• G extends Attributes = Attributes

Defined in​

-

packages/core/src/types.ts:17

+

packages/core/src/types.ts:17

\ No newline at end of file diff --git a/docs/api/index.html b/docs/api/index.html index 05089d68..c4580825 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/functions/useLayoutCirclepack/index.html b/docs/api/layout-circlepack/functions/useLayoutCirclepack/index.html index 4937443b..976de295 100644 --- a/docs/api/layout-circlepack/functions/useLayoutCirclepack/index.html +++ b/docs/api/layout-circlepack/functions/useLayoutCirclepack/index.html @@ -5,7 +5,7 @@ Function: useLayoutCirclepack() | React Sigma - + @@ -32,6 +32,6 @@

positions()Returns​

object

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-circlepack/index.html b/docs/api/layout-circlepack/index.html index 5a162fd8..d26111db 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 - + diff --git a/docs/api/layout-circular/functions/useLayoutCircular/index.html b/docs/api/layout-circular/functions/useLayoutCircular/index.html index b2d88497..fd335920 100644 --- a/docs/api/layout-circular/functions/useLayoutCircular/index.html +++ b/docs/api/layout-circular/functions/useLayoutCircular/index.html @@ -5,7 +5,7 @@ Function: useLayoutCircular() | React Sigma - + @@ -32,6 +32,6 @@

positions()Returns​

object

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-circular/index.html b/docs/api/layout-circular/index.html index b218c0e5..09fcde73 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 - + diff --git a/docs/api/layout-core/functions/WorkerLayoutControl/index.html b/docs/api/layout-core/functions/WorkerLayoutControl/index.html index 4c352218..60ef620c 100644 --- a/docs/api/layout-core/functions/WorkerLayoutControl/index.html +++ b/docs/api/layout-core/functions/WorkerLayoutControl/index.html @@ -5,7 +5,7 @@ Function: WorkerLayoutControl() | React Sigma - + @@ -20,6 +20,6 @@

ParametersReturns​

Element

Defined in​

-

WorkerLayoutControl.tsx:69

+

WorkerLayoutControl.tsx:69

\ No newline at end of file diff --git a/docs/api/layout-core/functions/useLayoutFactory/index.html b/docs/api/layout-core/functions/useLayoutFactory/index.html index d36e799f..45582bc8 100644 --- a/docs/api/layout-core/functions/useLayoutFactory/index.html +++ b/docs/api/layout-core/functions/useLayoutFactory/index.html @@ -5,7 +5,7 @@ Function: useLayoutFactory() | React Sigma - + @@ -22,6 +22,6 @@

ParametersReturns​

LayoutHook<T>

Defined in​

-

useLayoutFactory.ts:31

+

useLayoutFactory.ts:31

\ No newline at end of file diff --git a/docs/api/layout-core/functions/useWorkerLayoutFactory/index.html b/docs/api/layout-core/functions/useWorkerLayoutFactory/index.html index 6a5bde24..eca118d0 100644 --- a/docs/api/layout-core/functions/useWorkerLayoutFactory/index.html +++ b/docs/api/layout-core/functions/useWorkerLayoutFactory/index.html @@ -5,7 +5,7 @@ Function: useWorkerLayoutFactory() | React Sigma - + @@ -20,6 +20,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/index.html b/docs/api/layout-core/index.html index ef82db89..0e575b9f 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 - + diff --git a/docs/api/layout-core/interfaces/WorkerLayoutControlProps/index.html b/docs/api/layout-core/interfaces/WorkerLayoutControlProps/index.html index 32f5c4a0..8aae7518 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 - + @@ -25,7 +25,7 @@

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

Defined in​

-

WorkerLayoutControl.tsx:45

+

WorkerLayoutControl.tsx:45

children?​

@@ -36,7 +36,7 @@

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

Defined in​

-

WorkerLayoutControl.tsx:60

+

WorkerLayoutControl.tsx:60

className?​

@@ -44,7 +44,7 @@

className?

HTML class

Defined in​

-

WorkerLayoutControl.tsx:22

+

WorkerLayoutControl.tsx:22

id?​

@@ -52,7 +52,7 @@

id?

HTML id

Defined in​

-

WorkerLayoutControl.tsx:17

+

WorkerLayoutControl.tsx:17

labels?​

@@ -69,7 +69,7 @@

stopDefined in​

-

WorkerLayoutControl.tsx:66

+

WorkerLayoutControl.tsx:66

layout​

@@ -77,7 +77,7 @@

layoutDefined in​

-

WorkerLayoutControl.tsx:32

+

WorkerLayoutControl.tsx:32

settings​

@@ -85,7 +85,7 @@

settingsDefined in​

-

WorkerLayoutControl.tsx:37

+

WorkerLayoutControl.tsx:37

style?​

@@ -93,6 +93,6 @@

style?Defined in​

-

WorkerLayoutControl.tsx:27

+

WorkerLayoutControl.tsx:27

\ No newline at end of file diff --git a/docs/api/layout-core/type-aliases/LayoutHook/index.html b/docs/api/layout-core/type-aliases/LayoutHook/index.html index 35acd0a8..d86d8c0f 100644 --- a/docs/api/layout-core/type-aliases/LayoutHook/index.html +++ b/docs/api/layout-core/type-aliases/LayoutHook/index.html @@ -5,7 +5,7 @@ Type Alias: LayoutHook()\<T\> | React Sigma - + @@ -35,6 +35,6 @@

positions()Returns​

object

Defined in​

-

useLayoutFactory.ts:17

+

useLayoutFactory.ts:17

\ No newline at end of file diff --git a/docs/api/layout-core/type-aliases/LayoutWorkerHook/index.html b/docs/api/layout-core/type-aliases/LayoutWorkerHook/index.html index a5cc17c8..fef056e7 100644 --- a/docs/api/layout-core/type-aliases/LayoutWorkerHook/index.html +++ b/docs/api/layout-core/type-aliases/LayoutWorkerHook/index.html @@ -5,7 +5,7 @@ Type Alias: LayoutWorkerHook()\<T\> | React Sigma - + @@ -42,6 +42,6 @@

stop()Returns​

void

Defined in​

-

useWorkerLayoutFactory.ts:6

+

useWorkerLayoutFactory.ts:6

\ No newline at end of file diff --git a/docs/api/layout-force/functions/LayoutForceControl/index.html b/docs/api/layout-force/functions/LayoutForceControl/index.html index 3c75aec6..f75ab39e 100644 --- a/docs/api/layout-force/functions/LayoutForceControl/index.html +++ b/docs/api/layout-force/functions/LayoutForceControl/index.html @@ -5,7 +5,7 @@ Function: LayoutForceControl() | React Sigma - + @@ -20,6 +20,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-force/functions/useLayoutForce/index.html b/docs/api/layout-force/functions/useLayoutForce/index.html index 8afe35e9..f5813b60 100644 --- a/docs/api/layout-force/functions/useLayoutForce/index.html +++ b/docs/api/layout-force/functions/useLayoutForce/index.html @@ -5,7 +5,7 @@ Function: useLayoutForce() | React Sigma - + @@ -32,6 +32,6 @@

positions()Returns​

object

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-force/functions/useWorkerLayoutForce/index.html b/docs/api/layout-force/functions/useWorkerLayoutForce/index.html index 4a088d95..9ae32cd9 100644 --- a/docs/api/layout-force/functions/useWorkerLayoutForce/index.html +++ b/docs/api/layout-force/functions/useWorkerLayoutForce/index.html @@ -5,7 +5,7 @@ Function: useWorkerLayoutForce() | React Sigma - + @@ -42,6 +42,6 @@

stop()Returns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-force/index.html b/docs/api/layout-force/index.html index 079ce386..e82bc0fd 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 - + diff --git a/docs/api/layout-force/type-aliases/LayoutForceControlProps/index.html b/docs/api/layout-force/type-aliases/LayoutForceControlProps/index.html index 8970b652..0646ce2f 100644 --- a/docs/api/layout-force/type-aliases/LayoutForceControlProps/index.html +++ b/docs/api/layout-force/type-aliases/LayoutForceControlProps/index.html @@ -5,7 +5,7 @@ Type Alias: LayoutForceControlProps | React Sigma - + @@ -20,6 +20,6 @@

settings?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/functions/LayoutForceAtlas2Control/index.html b/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control/index.html index 08c117cd..fe0518ed 100644 --- a/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control/index.html +++ b/docs/api/layout-forceatlas2/functions/LayoutForceAtlas2Control/index.html @@ -5,7 +5,7 @@ Function: LayoutForceAtlas2Control() | React Sigma - + @@ -19,6 +19,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2/index.html b/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2/index.html index b20a2749..04347222 100644 --- a/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2/index.html +++ b/docs/api/layout-forceatlas2/functions/useLayoutForceAtlas2/index.html @@ -5,7 +5,7 @@ Function: useLayoutForceAtlas2() | React Sigma - + @@ -32,6 +32,6 @@

positions()Returns​

object

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2/index.html b/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2/index.html index a9820164..59a1e669 100644 --- a/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2/index.html +++ b/docs/api/layout-forceatlas2/functions/useWorkerLayoutForceAtlas2/index.html @@ -5,7 +5,7 @@ Function: useWorkerLayoutForceAtlas2() | React Sigma - + @@ -42,6 +42,6 @@

stop()Returns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-forceatlas2/index.html b/docs/api/layout-forceatlas2/index.html index eacfab61..a5947843 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 - + diff --git a/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps/index.html b/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps/index.html index 7f3d77b1..fcbbfd7c 100644 --- a/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps/index.html +++ b/docs/api/layout-forceatlas2/type-aliases/LayoutForceAtlas2ControlProps/index.html @@ -5,7 +5,7 @@ Type Alias: LayoutForceAtlas2ControlProps | React Sigma - + @@ -20,6 +20,6 @@

settings?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/functions/LayoutNoverlapControl/index.html b/docs/api/layout-noverlap/functions/LayoutNoverlapControl/index.html index 1791bcc7..4923c0db 100644 --- a/docs/api/layout-noverlap/functions/LayoutNoverlapControl/index.html +++ b/docs/api/layout-noverlap/functions/LayoutNoverlapControl/index.html @@ -5,7 +5,7 @@ Function: LayoutNoverlapControl() | React Sigma - + @@ -19,6 +19,6 @@

ParametersReturns​

ReactNode

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-noverlap/functions/useLayoutNoverlap/index.html b/docs/api/layout-noverlap/functions/useLayoutNoverlap/index.html index ff6a9328..0e979a13 100644 --- a/docs/api/layout-noverlap/functions/useLayoutNoverlap/index.html +++ b/docs/api/layout-noverlap/functions/useLayoutNoverlap/index.html @@ -5,7 +5,7 @@ Function: useLayoutNoverlap() | React Sigma - + @@ -32,6 +32,6 @@

positions()Returns​

object

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap/index.html b/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap/index.html index 67d2161a..ef53c4d6 100644 --- a/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap/index.html +++ b/docs/api/layout-noverlap/functions/useWorkerLayoutNoverlap/index.html @@ -5,7 +5,7 @@ Function: useWorkerLayoutNoverlap() | React Sigma - + @@ -42,6 +42,6 @@

stop()Returns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/docs/api/layout-noverlap/index.html b/docs/api/layout-noverlap/index.html index ac38e486..55091f6c 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 - + diff --git a/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps/index.html b/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps/index.html index f7ff3d0f..cf3f1af1 100644 --- a/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps/index.html +++ b/docs/api/layout-noverlap/type-aliases/LayoutNoverlapControlProps/index.html @@ -5,7 +5,7 @@ Type Alias: LayoutNoverlapControlProps | React Sigma - + @@ -20,6 +20,6 @@

settings?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/functions/useLayoutRandom/index.html b/docs/api/layout-random/functions/useLayoutRandom/index.html index 016d73b4..f5892305 100644 --- a/docs/api/layout-random/functions/useLayoutRandom/index.html +++ b/docs/api/layout-random/functions/useLayoutRandom/index.html @@ -5,7 +5,7 @@ Function: useLayoutRandom() | React Sigma - + @@ -30,6 +30,6 @@

positions()Returns​

object

Defined in​

-

layout-random/src/useLayoutRandom.ts:14

+

layout-random/src/useLayoutRandom.ts:14

\ No newline at end of file diff --git a/docs/api/layout-random/index.html b/docs/api/layout-random/index.html index 747cfdb1..27f58294 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 - + diff --git a/docs/changelog/index.html b/docs/changelog/index.html index 32df79e5..09e93262 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 9ee1fe4b..9ca7b5fc 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 d97b4c4e..d4e88981 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 3c479373..9e62d847 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 ec93d5c6..56fd5c4e 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 6064c566..eace5a3d 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 4630ad83..1c41620b 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 8c375d8d..91dcaa1b 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 5a5ff51b..8680a7a2 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 df9c8a58..b40168b0 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 f3487092..1b870480 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 b9f06d77..1a9458c0 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 0662d62a..80f32e06 100644 --- a/storybook/project.json +++ b/storybook/project.json @@ -1 +1 @@ -{"generatedAt":1721908414725,"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":1721908809418,"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"}}}