better doc'

This commit is contained in:
tamat
2018-10-23 12:24:41 +02:00
parent c42dd8391e
commit c69e8ca5d5
11 changed files with 17818 additions and 14697 deletions

View File

@@ -85,7 +85,7 @@
<div class="foundat">
Defined in: <a href="../files/.._src_litegraph.js.html#l378"><code>..&#x2F;src&#x2F;litegraph.js:378</code></a>
Defined in: <a href="../files/.._src_litegraph.js.html#l405"><code>..&#x2F;src&#x2F;litegraph.js:405</code></a>
</div>
@@ -102,7 +102,13 @@
<div id="method_LGraph" class="method item">
<h3 class="name"><code>LGraph</code></h3>
<span class="paren">()</span>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
@@ -114,7 +120,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l378"><code>..&#x2F;src&#x2F;litegraph.js:378</code></a>
<a href="../files/.._src_litegraph.js.html#l405"><code>..&#x2F;src&#x2F;litegraph.js:405</code></a>
</p>
@@ -125,6 +131,23 @@
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type">Object</span>
<div class="param-description">
<p>data from previous serialization [optional]</p>
</div>
</li>
</ul>
</div>
@@ -197,6 +220,10 @@
<li class="index-item method">
<a href="#method_findNodesByType">findNodesByType</a>
</li>
<li class="index-item method">
<a href="#method_getAncestors">getAncestors</a>
</li>
<li class="index-item method">
<a href="#method_getElapsedTime">getElapsedTime</a>
@@ -213,6 +240,10 @@
<li class="index-item method">
<a href="#method_getGlobalOutputData">getGlobalOutputData</a>
</li>
<li class="index-item method">
<a href="#method_getGroupOnPos">getGroupOnPos</a>
</li>
<li class="index-item method">
<a href="#method_getNodeById">getNodeById</a>
@@ -321,7 +352,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l856"><code>..&#x2F;src&#x2F;litegraph.js:856</code></a>
<a href="../files/.._src_litegraph.js.html#l947"><code>..&#x2F;src&#x2F;litegraph.js:947</code></a>
</p>
@@ -381,7 +412,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1065"><code>..&#x2F;src&#x2F;litegraph.js:1065</code></a>
<a href="../files/.._src_litegraph.js.html#l1194"><code>..&#x2F;src&#x2F;litegraph.js:1194</code></a>
</p>
@@ -461,7 +492,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1190"><code>..&#x2F;src&#x2F;litegraph.js:1190</code></a>
<a href="../files/.._src_litegraph.js.html#l1323"><code>..&#x2F;src&#x2F;litegraph.js:1323</code></a>
</p>
@@ -528,7 +559,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l736"><code>..&#x2F;src&#x2F;litegraph.js:736</code></a>
<a href="../files/.._src_litegraph.js.html#l827"><code>..&#x2F;src&#x2F;litegraph.js:827</code></a>
</p>
@@ -565,7 +596,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l453"><code>..&#x2F;src&#x2F;litegraph.js:453</code></a>
<a href="../files/.._src_litegraph.js.html#l489"><code>..&#x2F;src&#x2F;litegraph.js:489</code></a>
</p>
@@ -621,7 +652,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1150"><code>..&#x2F;src&#x2F;litegraph.js:1150</code></a>
<a href="../files/.._src_litegraph.js.html#l1281"><code>..&#x2F;src&#x2F;litegraph.js:1281</code></a>
</p>
@@ -687,7 +718,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1272"><code>..&#x2F;src&#x2F;litegraph.js:1272</code></a>
<a href="../files/.._src_litegraph.js.html#l1407"><code>..&#x2F;src&#x2F;litegraph.js:1407</code></a>
</p>
@@ -744,7 +775,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l404"><code>..&#x2F;src&#x2F;litegraph.js:404</code></a>
<a href="../files/.._src_litegraph.js.html#l435"><code>..&#x2F;src&#x2F;litegraph.js:435</code></a>
</p>
@@ -768,6 +799,9 @@
<li class="arg">
<code>str</code>
</li>
<li class="arg">
<code>returns</code>
</li>
</ul><span class="paren">)</span>
</div>
@@ -781,7 +815,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1403"><code>..&#x2F;src&#x2F;litegraph.js:1403</code></a>
<a href="../files/.._src_litegraph.js.html#l1542"><code>..&#x2F;src&#x2F;litegraph.js:1542</code></a>
</p>
@@ -808,6 +842,17 @@
</div>
</li>
<li class="param">
<code class="param-name">returns</code>
<span class="type">Boolean</span>
<div class="param-description">
<p>if there was any error parsing</p>
</div>
</li>
</ul>
</div>
@@ -835,7 +880,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l472"><code>..&#x2F;src&#x2F;litegraph.js:472</code></a>
<a href="../files/.._src_litegraph.js.html#l508"><code>..&#x2F;src&#x2F;litegraph.js:508</code></a>
</p>
@@ -891,7 +936,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l994"><code>..&#x2F;src&#x2F;litegraph.js:994</code></a>
<a href="../files/.._src_litegraph.js.html#l1105"><code>..&#x2F;src&#x2F;litegraph.js:1105</code></a>
</p>
@@ -957,7 +1002,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1027"><code>..&#x2F;src&#x2F;litegraph.js:1027</code></a>
<a href="../files/.._src_litegraph.js.html#l1138"><code>..&#x2F;src&#x2F;litegraph.js:1138</code></a>
</p>
@@ -1023,7 +1068,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1010"><code>..&#x2F;src&#x2F;litegraph.js:1010</code></a>
<a href="../files/.._src_litegraph.js.html#l1121"><code>..&#x2F;src&#x2F;litegraph.js:1121</code></a>
</p>
@@ -1064,6 +1109,50 @@
</div>
</div>
<div id="method_getAncestors" class="method item">
<h3 class="name"><code>getAncestors</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l790"><code>..&#x2F;src&#x2F;litegraph.js:790</code></a>
</p>
</div>
<div class="description">
<p>Returns all the nodes that could affect this one (ancestors) by crawling all the inputs recursively.
It doesnt include the node itself</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
<p>an array with all the LGraphNodes that affect this node, in order of execution</p>
</div>
</div>
</div>
<div id="method_getElapsedTime" class="method item">
<h3 class="name"><code>getElapsedTime</code></h3>
@@ -1083,7 +1172,7 @@
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l801"><code>..&#x2F;src&#x2F;litegraph.js:801</code></a>
<a href="../files/.._src_litegraph.js.html#l892"><code>..&#x2F;src&#x2F;litegraph.js:892</code></a>
</p>
@@ -1127,7 +1216,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l790"><code>..&#x2F;src&#x2F;litegraph.js:790</code></a>
<a href="../files/.._src_litegraph.js.html#l881"><code>..&#x2F;src&#x2F;litegraph.js:881</code></a>
</p>
@@ -1176,7 +1265,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1106"><code>..&#x2F;src&#x2F;litegraph.js:1106</code></a>
<a href="../files/.._src_litegraph.js.html#l1236"><code>..&#x2F;src&#x2F;litegraph.js:1236</code></a>
</p>
@@ -1241,7 +1330,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1222"><code>..&#x2F;src&#x2F;litegraph.js:1222</code></a>
<a href="../files/.._src_litegraph.js.html#l1356"><code>..&#x2F;src&#x2F;litegraph.js:1356</code></a>
</p>
@@ -1281,6 +1370,86 @@ if the nodes are using graphical actions</p>
</div>
</div>
<div id="method_getGroupOnPos" class="method item">
<h3 class="name"><code>getGroupOnPos</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>x</code>
</li>
<li class="arg">
<code>y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">LGraphGroup</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1174"><code>..&#x2F;src&#x2F;litegraph.js:1174</code></a>
</p>
</div>
<div class="description">
<p>Returns the top-most group in that position</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">x</code>
<span class="type">Number</span>
<div class="param-description">
<p>the x coordinate in canvas space</p>
</div>
</li>
<li class="param">
<code class="param-name">y</code>
<span class="type">Number</span>
<div class="param-description">
<p>the y coordinate in canvas space</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">LGraphGroup</span>:
<p>the group or null</p>
</div>
</div>
</div>
<div id="method_getNodeById" class="method item">
<h3 class="name"><code>getNodeById</code></h3>
@@ -1303,7 +1472,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l981"><code>..&#x2F;src&#x2F;litegraph.js:981</code></a>
<a href="../files/.._src_litegraph.js.html#l1092"><code>..&#x2F;src&#x2F;litegraph.js:1092</code></a>
</p>
@@ -1353,7 +1522,7 @@ if the nodes are using graphical actions</p>
</div>
<span class="returns-inline">
<span class="type">Array</span>
<span class="type"><a href="../classes/LGraphNode.html" class="crosslink">LGraphNode</a></span>
</span>
@@ -1365,7 +1534,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1043"><code>..&#x2F;src&#x2F;litegraph.js:1043</code></a>
<a href="../files/.._src_litegraph.js.html#l1154"><code>..&#x2F;src&#x2F;litegraph.js:1154</code></a>
</p>
@@ -1421,8 +1590,8 @@ if the nodes are using graphical actions</p>
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
<p>a list with all the nodes that intersect this coordinate</p>
<span class="type"><a href="../classes/LGraphNode.html" class="crosslink">LGraphNode</a></span>:
<p>the node at this position or null</p>
</div>
</div>
@@ -1453,7 +1622,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1236"><code>..&#x2F;src&#x2F;litegraph.js:1236</code></a>
<a href="../files/.._src_litegraph.js.html#l1370"><code>..&#x2F;src&#x2F;litegraph.js:1370</code></a>
</p>
@@ -1512,7 +1681,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l780"><code>..&#x2F;src&#x2F;litegraph.js:780</code></a>
<a href="../files/.._src_litegraph.js.html#l871"><code>..&#x2F;src&#x2F;litegraph.js:871</code></a>
</p>
@@ -1552,7 +1721,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1333"><code>..&#x2F;src&#x2F;litegraph.js:1333</code></a>
<a href="../files/.._src_litegraph.js.html#l1471"><code>..&#x2F;src&#x2F;litegraph.js:1471</code></a>
</p>
@@ -1589,7 +1758,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l912"><code>..&#x2F;src&#x2F;litegraph.js:912</code></a>
<a href="../files/.._src_litegraph.js.html#l1011"><code>..&#x2F;src&#x2F;litegraph.js:1011</code></a>
</p>
@@ -1646,7 +1815,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1169"><code>..&#x2F;src&#x2F;litegraph.js:1169</code></a>
<a href="../files/.._src_litegraph.js.html#l1301"><code>..&#x2F;src&#x2F;litegraph.js:1301</code></a>
</p>
@@ -1709,7 +1878,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1291"><code>..&#x2F;src&#x2F;litegraph.js:1291</code></a>
<a href="../files/.._src_litegraph.js.html#l1427"><code>..&#x2F;src&#x2F;litegraph.js:1427</code></a>
</p>
@@ -1765,7 +1934,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1120"><code>..&#x2F;src&#x2F;litegraph.js:1120</code></a>
<a href="../files/.._src_litegraph.js.html#l1250"><code>..&#x2F;src&#x2F;litegraph.js:1250</code></a>
</p>
@@ -1831,7 +2000,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1245"><code>..&#x2F;src&#x2F;litegraph.js:1245</code></a>
<a href="../files/.._src_litegraph.js.html#l1379"><code>..&#x2F;src&#x2F;litegraph.js:1379</code></a>
</p>
@@ -1894,7 +2063,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l540"><code>..&#x2F;src&#x2F;litegraph.js:540</code></a>
<a href="../files/.._src_litegraph.js.html#l576"><code>..&#x2F;src&#x2F;litegraph.js:576</code></a>
</p>
@@ -1951,7 +2120,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l813"><code>..&#x2F;src&#x2F;litegraph.js:813</code></a>
<a href="../files/.._src_litegraph.js.html#l904"><code>..&#x2F;src&#x2F;litegraph.js:904</code></a>
</p>
@@ -2013,7 +2182,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1370"><code>..&#x2F;src&#x2F;litegraph.js:1370</code></a>
<a href="../files/.._src_litegraph.js.html#l1506"><code>..&#x2F;src&#x2F;litegraph.js:1506</code></a>
</p>
@@ -2062,7 +2231,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1083"><code>..&#x2F;src&#x2F;litegraph.js:1083</code></a>
<a href="../files/.._src_litegraph.js.html#l1213"><code>..&#x2F;src&#x2F;litegraph.js:1213</code></a>
</p>
@@ -2128,7 +2297,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1208"><code>..&#x2F;src&#x2F;litegraph.js:1208</code></a>
<a href="../files/.._src_litegraph.js.html#l1342"><code>..&#x2F;src&#x2F;litegraph.js:1342</code></a>
</p>
@@ -2194,7 +2363,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l1097"><code>..&#x2F;src&#x2F;litegraph.js:1097</code></a>
<a href="../files/.._src_litegraph.js.html#l1227"><code>..&#x2F;src&#x2F;litegraph.js:1227</code></a>
</p>
@@ -2257,7 +2426,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l490"><code>..&#x2F;src&#x2F;litegraph.js:490</code></a>
<a href="../files/.._src_litegraph.js.html#l525"><code>..&#x2F;src&#x2F;litegraph.js:525</code></a>
</p>
@@ -2305,7 +2474,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l518"><code>..&#x2F;src&#x2F;litegraph.js:518</code></a>
<a href="../files/.._src_litegraph.js.html#l554"><code>..&#x2F;src&#x2F;litegraph.js:554</code></a>
</p>
@@ -2336,7 +2505,7 @@ if the nodes are using graphical actions</p>
<div class="meta">
<p>
Defined in
<a href="../files/.._src_litegraph.js.html#l619"><code>..&#x2F;src&#x2F;litegraph.js:619</code></a>
<a href="../files/.._src_litegraph.js.html#l658"><code>..&#x2F;src&#x2F;litegraph.js:658</code></a>
</p>