Skip to content

Commit 9a64e5b

Browse files
thebestnomthebestnom
committed
Update docs
1 parent 8e1238a commit 9a64e5b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+3273
-137
lines changed

‎MIGRATING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
2.0.0 was designed to be an extension of vis-network instead of a wrapper, that's means that all custom-made properties
44
are now the vis-network name
55

6+
## quick migration
7+
```ts
8+
oldConfig = {
9+
//... old configuration
10+
}
11+
const newConfig = NeoVis.migrateFromOldConfig(oldConfig);
12+
// or
13+
import { migrateFromOldConfig } from "neovis.js";
14+
const newConfig = migrateFromOldConfig(oldConfig)
15+
```
16+
17+
618
## specifics
719

820
- neo4j driver configuration moved from flat onto the config object to `neo4j` onto the object

‎__tests__/neovis.tests.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ describe('Neovis', () => {
303303
initial_cypher: initial_cypher
304304
}], ['non flat config', {
305305
container_id,
306-
non_flat: true,
306+
nonFlat: true,
307307
labels: {
308308
[label1]: {
309309
static: {

‎dist/neovis-without-dependencies.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/neovis-without-dependencies.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/neovis.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/neovis.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/html/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/html/classes/neovis.html

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -113,19 +113,19 @@ <h2>Constructors</h2>
113113
<a name="constructor" class="tsd-anchor"></a>
114114
<h3>constructor</h3>
115115
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
116-
<li class="tsd-signature tsd-kind-icon">new <wbr>Neo<wbr>Vis<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="neovis.html" class="tsd-signature-type" data-tsd-kind="Class">NeoVis</a></li>
116+
<li class="tsd-signature tsd-kind-icon">new <wbr>Neo<wbr>Vis<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/nonflatneovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NonFlatNeovisConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="neovis.html" class="tsd-signature-type" data-tsd-kind="Class">NeoVis</a></li>
117117
</ul>
118118
<ul class="tsd-descriptions">
119119
<li class="tsd-description">
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L265">index.d.ts:265</a></li>
122+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L345">index.d.ts:345</a></li>
123123
</ul>
124124
</aside>
125125
<h4 class="tsd-parameters-title">Parameters</h4>
126126
<ul class="tsd-parameters">
127127
<li>
128-
<h5>config: <a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a></h5>
128+
<h5>config: <a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/nonflatneovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NonFlatNeovisConfig</a></h5>
129129
</li>
130130
</ul>
131131
<h4 class="tsd-returns-title">Returns <a href="neovis.html" class="tsd-signature-type" data-tsd-kind="Class">NeoVis</a></h4>
@@ -145,7 +145,7 @@ <h3>edges</h3>
145145
<li class="tsd-description">
146146
<aside class="tsd-sources">
147147
<ul>
148-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L278">index.d.ts:278</a></li>
148+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L358">index.d.ts:358</a></li>
149149
</ul>
150150
</aside>
151151
<div class="tsd-comment tsd-typography">
@@ -172,7 +172,7 @@ <h3>network</h3>
172172
<li class="tsd-description">
173173
<aside class="tsd-sources">
174174
<ul>
175-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L284">index.d.ts:284</a></li>
175+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L364">index.d.ts:364</a></li>
176176
</ul>
177177
</aside>
178178
<div class="tsd-comment tsd-typography">
@@ -199,7 +199,7 @@ <h3>nodes</h3>
199199
<li class="tsd-description">
200200
<aside class="tsd-sources">
201201
<ul>
202-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L272">index.d.ts:272</a></li>
202+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L352">index.d.ts:352</a></li>
203203
</ul>
204204
</aside>
205205
<div class="tsd-comment tsd-typography">
@@ -229,7 +229,7 @@ <h3>clear<wbr>Network</h3>
229229
<li class="tsd-description">
230230
<aside class="tsd-sources">
231231
<ul>
232-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L294">index.d.ts:294</a></li>
232+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L374">index.d.ts:374</a></li>
233233
</ul>
234234
</aside>
235235
<div class="tsd-comment tsd-typography">
@@ -251,7 +251,7 @@ <h3>register<wbr>OnEvent</h3>
251251
<li class="tsd-description">
252252
<aside class="tsd-sources">
253253
<ul>
254-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L301">index.d.ts:301</a></li>
254+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L381">index.d.ts:381</a></li>
255255
</ul>
256256
</aside>
257257
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -295,13 +295,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
295295
<a name="reinit" class="tsd-anchor"></a>
296296
<h3>reinit</h3>
297297
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
298-
<li class="tsd-signature tsd-kind-icon">reinit<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
298+
<li class="tsd-signature tsd-kind-icon">reinit<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/nonflatneovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NonFlatNeovisConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
299299
</ul>
300300
<ul class="tsd-descriptions">
301301
<li class="tsd-description">
302302
<aside class="tsd-sources">
303303
<ul>
304-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L307">index.d.ts:307</a></li>
304+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L387">index.d.ts:387</a></li>
305305
</ul>
306306
</aside>
307307
<div class="tsd-comment tsd-typography">
@@ -312,7 +312,7 @@ <h3>reinit</h3>
312312
<h4 class="tsd-parameters-title">Parameters</h4>
313313
<ul class="tsd-parameters">
314314
<li>
315-
<h5>config: <a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a></h5>
315+
<h5>config: <a href="../interfaces/neovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NeovisConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/nonflatneovisconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NonFlatNeovisConfig</a></h5>
316316
<div class="tsd-comment tsd-typography">
317317
</div>
318318
</li>
@@ -331,7 +331,7 @@ <h3>reload</h3>
331331
<li class="tsd-description">
332332
<aside class="tsd-sources">
333333
<ul>
334-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L312">index.d.ts:312</a></li>
334+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L392">index.d.ts:392</a></li>
335335
</ul>
336336
</aside>
337337
<div class="tsd-comment tsd-typography">
@@ -353,7 +353,7 @@ <h3>render</h3>
353353
<li class="tsd-description">
354354
<aside class="tsd-sources">
355355
<ul>
356-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L289">index.d.ts:289</a></li>
356+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L369">index.d.ts:369</a></li>
357357
</ul>
358358
</aside>
359359
<div class="tsd-comment tsd-typography">
@@ -375,7 +375,7 @@ <h3>render<wbr>With<wbr>Cypher</h3>
375375
<li class="tsd-description">
376376
<aside class="tsd-sources">
377377
<ul>
378-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L323">index.d.ts:323</a></li>
378+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L403">index.d.ts:403</a></li>
379379
</ul>
380380
</aside>
381381
<div class="tsd-comment tsd-typography">
@@ -405,7 +405,7 @@ <h3>stabilize</h3>
405405
<li class="tsd-description">
406406
<aside class="tsd-sources">
407407
<ul>
408-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L317">index.d.ts:317</a></li>
408+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L397">index.d.ts:397</a></li>
409409
</ul>
410410
</aside>
411411
<div class="tsd-comment tsd-typography">
@@ -427,7 +427,7 @@ <h3>update<wbr>With<wbr>Cypher</h3>
427427
<li class="tsd-description">
428428
<aside class="tsd-sources">
429429
<ul>
430-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L330">index.d.ts:330</a></li>
430+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L410">index.d.ts:410</a></li>
431431
</ul>
432432
</aside>
433433
<div class="tsd-comment tsd-typography">
@@ -511,6 +511,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
511511
</li>
512512
</ul>
513513
<ul class="after-current">
514+
<li class=" tsd-kind-interface">
515+
<a href="../interfaces/baseneovisconfig.html" class="tsd-kind-icon">Base<wbr>Neovis<wbr>Config</a>
516+
</li>
514517
<li class=" tsd-kind-interface">
515518
<a href="../interfaces/edge.html" class="tsd-kind-icon">Edge</a>
516519
</li>
@@ -529,6 +532,21 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
529532
<li class=" tsd-kind-interface">
530533
<a href="../interfaces/node.html" class="tsd-kind-icon">Node</a>
531534
</li>
535+
<li class=" tsd-kind-interface tsd-has-type-parameter">
536+
<a href="../interfaces/nonflatneovisadvanceconfig.html" class="tsd-kind-icon">Non<wbr>Flat<wbr>Neo<wbr>Vis<wbr>Advance<wbr>Config</a>
537+
</li>
538+
<li class=" tsd-kind-interface">
539+
<a href="../interfaces/nonflatneovisconfig.html" class="tsd-kind-icon">Non<wbr>Flat<wbr>Neovis<wbr>Config</a>
540+
</li>
541+
<li class=" tsd-kind-interface">
542+
<a href="../interfaces/oldlabelconfig.html" class="tsd-kind-icon">Old<wbr>Label<wbr>Config</a>
543+
</li>
544+
<li class=" tsd-kind-interface">
545+
<a href="../interfaces/oldneovisconfig.html" class="tsd-kind-icon">Old<wbr>Neo<wbr>Vis<wbr>Config</a>
546+
</li>
547+
<li class=" tsd-kind-interface">
548+
<a href="../interfaces/oldrelationshipconfig.html" class="tsd-kind-icon">Old<wbr>Relationship<wbr>Config</a>
549+
</li>
532550
<li class=" tsd-kind-interface">
533551
<a href="../interfaces/relationshipconfig.html" class="tsd-kind-icon">Relationship<wbr>Config</a>
534552
</li>
@@ -547,6 +565,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
547565
<li class=" tsd-kind-variable">
548566
<a href="../modules.html#neovis_default_config" class="tsd-kind-icon">NEOVIS_<wbr>DEFAULT_<wbr>CONFIG</a>
549567
</li>
568+
<li class=" tsd-kind-function">
569+
<a href="../modules.html#migratefromoldconfig" class="tsd-kind-icon">migrate<wbr>From<wbr>Old<wbr>Config</a>
570+
</li>
550571
<li class=" tsd-kind-function">
551572
<a href="../modules.html#objecttotitlehtml" class="tsd-kind-icon">object<wbr>ToTitle<wbr>Html</a>
552573
</li>

‎docs/html/enums/neovisevents.html

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h3>Click<wbr>Edge<wbr>Event</h3>
9696
<div class="tsd-signature tsd-kind-icon">Click<wbr>Edge<wbr>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;clickEdge&quot;</span></div>
9797
<aside class="tsd-sources">
9898
<ul>
99-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L13">index.d.ts:13</a></li>
99+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L13">index.d.ts:13</a></li>
100100
</ul>
101101
</aside>
102102
</section>
@@ -106,7 +106,7 @@ <h3>Click<wbr>Node<wbr>Event</h3>
106106
<div class="tsd-signature tsd-kind-icon">Click<wbr>Node<wbr>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;clickNode&quot;</span></div>
107107
<aside class="tsd-sources">
108108
<ul>
109-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L12">index.d.ts:12</a></li>
109+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L12">index.d.ts:12</a></li>
110110
</ul>
111111
</aside>
112112
</section>
@@ -116,7 +116,7 @@ <h3>Completion<wbr>Event</h3>
116116
<div class="tsd-signature tsd-kind-icon">Completion<wbr>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;completed&quot;</span></div>
117117
<aside class="tsd-sources">
118118
<ul>
119-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L11">index.d.ts:11</a></li>
119+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L11">index.d.ts:11</a></li>
120120
</ul>
121121
</aside>
122122
</section>
@@ -126,7 +126,7 @@ <h3>Error<wbr>Event</h3>
126126
<div class="tsd-signature tsd-kind-icon">Error<wbr>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;error&quot;</span></div>
127127
<aside class="tsd-sources">
128128
<ul>
129-
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/0d65c84/index.d.ts#L14">index.d.ts:14</a></li>
129+
<li>Defined in <a href="https://github.com/thebestnom/neovis.js/blob/ed1c244/index.d.ts#L14">index.d.ts:14</a></li>
130130
</ul>
131131
</aside>
132132
</section>
@@ -169,6 +169,9 @@ <h3>Error<wbr>Event</h3>
169169
<li class=" tsd-kind-class">
170170
<a href="../classes/neovis.html" class="tsd-kind-icon">Neo<wbr>Vis</a>
171171
</li>
172+
<li class=" tsd-kind-interface">
173+
<a href="../interfaces/baseneovisconfig.html" class="tsd-kind-icon">Base<wbr>Neovis<wbr>Config</a>
174+
</li>
172175
<li class=" tsd-kind-interface">
173176
<a href="../interfaces/edge.html" class="tsd-kind-icon">Edge</a>
174177
</li>
@@ -187,6 +190,21 @@ <h3>Error<wbr>Event</h3>
187190
<li class=" tsd-kind-interface">
188191
<a href="../interfaces/node.html" class="tsd-kind-icon">Node</a>
189192
</li>
193+
<li class=" tsd-kind-interface tsd-has-type-parameter">
194+
<a href="../interfaces/nonflatneovisadvanceconfig.html" class="tsd-kind-icon">Non<wbr>Flat<wbr>Neo<wbr>Vis<wbr>Advance<wbr>Config</a>
195+
</li>
196+
<li class=" tsd-kind-interface">
197+
<a href="../interfaces/nonflatneovisconfig.html" class="tsd-kind-icon">Non<wbr>Flat<wbr>Neovis<wbr>Config</a>
198+
</li>
199+
<li class=" tsd-kind-interface">
200+
<a href="../interfaces/oldlabelconfig.html" class="tsd-kind-icon">Old<wbr>Label<wbr>Config</a>
201+
</li>
202+
<li class=" tsd-kind-interface">
203+
<a href="../interfaces/oldneovisconfig.html" class="tsd-kind-icon">Old<wbr>Neo<wbr>Vis<wbr>Config</a>
204+
</li>
205+
<li class=" tsd-kind-interface">
206+
<a href="../interfaces/oldrelationshipconfig.html" class="tsd-kind-icon">Old<wbr>Relationship<wbr>Config</a>
207+
</li>
190208
<li class=" tsd-kind-interface">
191209
<a href="../interfaces/relationshipconfig.html" class="tsd-kind-icon">Relationship<wbr>Config</a>
192210
</li>
@@ -205,6 +223,9 @@ <h3>Error<wbr>Event</h3>
205223
<li class=" tsd-kind-variable">
206224
<a href="../modules.html#neovis_default_config" class="tsd-kind-icon">NEOVIS_<wbr>DEFAULT_<wbr>CONFIG</a>
207225
</li>
226+
<li class=" tsd-kind-function">
227+
<a href="../modules.html#migratefromoldconfig" class="tsd-kind-icon">migrate<wbr>From<wbr>Old<wbr>Config</a>
228+
</li>
208229
<li class=" tsd-kind-function">
209230
<a href="../modules.html#objecttotitlehtml" class="tsd-kind-icon">object<wbr>ToTitle<wbr>Html</a>
210231
</li>

0 commit comments

Comments
 (0)